diff options
| author | Joel Martinez <joelmartinez@gmail.com> | 2014-04-28 04:41:26 +0400 |
|---|---|---|
| committer | Joel Martinez <joelmartinez@gmail.com> | 2014-04-28 05:33:01 +0400 |
| commit | 6999270099fb530945023095063828765e1eb1c7 (patch) | |
| tree | 83cf08ef6dee957c5ebf3a35e2df7797ceec4c55 /mcs/class/System.Design | |
| parent | 7c67e309d8c555c6ca39472d62980874ff0e5ea4 (diff) | |
[docs] Import of Microsoft BCL Documentation.
The documentation is creative commons licensed.
Diffstat (limited to 'mcs/class/System.Design')
272 files changed, 20267 insertions, 5072 deletions
diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceDescriptor.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceDescriptor.xml index e6333e8e1b3..af198ffef8e 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceDescriptor.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceDescriptor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSourceDescriptor" FullName="System.ComponentModel.Design.Data.DataSourceDescriptor"> <TypeSignature Language="C#" Value="public abstract class DataSourceDescriptor" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implements the basic functionality required by a single data source at the EnvDTE.Project level.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Image"> @@ -35,9 +42,15 @@ <ReturnType>System.Drawing.Bitmap</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.Drawing.Bitmap" /> image that represents the data source is typically used in design-time pickers. The image may be null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, closes this stream and the underlying stream gets the <see cref="T:System.Drawing.Bitmap" /> image that represents the data source.</para> + </summary> </Docs> </Member> <Member MemberName="IsDesignable"> @@ -50,9 +63,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the data source is designable, meaning that an instance of this type will be added to the design surface when binding. Designable data sources are bound by instance rather than by type. Data sources of type <see cref="T:System.ComponentModel.IComponent" /> are designable.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the value indicating whether the data source is designable.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -65,9 +84,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The name of the data source must be unique across all data sources at the EnvDTE.Project level.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the name of the data source.</para> + </summary> </Docs> </Member> <Member MemberName="TypeName"> @@ -80,10 +105,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the fully qualified type name of the data source.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceDescriptorCollection.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceDescriptorCollection.xml index 34703fdba46..1602fa59924 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceDescriptorCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceDescriptorCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSourceDescriptorCollection" FullName="System.ComponentModel.Design.Data.DataSourceDescriptorCollection"> <TypeSignature Language="C#" Value="public class DataSourceDescriptorCollection : System.Collections.CollectionBase" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type-safe collection of <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> objects.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptorCollection" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Add"> @@ -38,10 +45,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceDescriptor" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> to the collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> to add to the collection.</param> </Docs> </Member> <Member MemberName="Contains"> @@ -57,10 +68,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceDescriptor" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptorCollection" /> contains the specified <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> to locate.</param> </Docs> </Member> <Member MemberName="CopyTo"> @@ -77,10 +92,15 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptorCollection" /> values to a one-dimensional <see cref="T:System.Array" /> at the specified index.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional <see cref="T:System.Array" /> that is the destination of the values copied from the <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptorCollection" />.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The index in the <paramref name="array" /> where copying begins.</param> </Docs> </Member> <Member MemberName="IndexOf"> @@ -96,10 +116,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceDescriptor" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the index of a <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> in the <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptorCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> to locate.</param> </Docs> </Member> <Member MemberName="Insert"> @@ -116,10 +140,15 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceDescriptor" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts a <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> into the <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptorCollection" /> at the specified index.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index where <paramref name="value" /> should be inserted. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> to insert.</param> </Docs> </Member> <Member MemberName="Item"> @@ -154,10 +183,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceDescriptor" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes a specific <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> from the <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptorCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptor" /> to remove from the <see cref="T:System.ComponentModel.Design.Data.DataSourceDescriptorCollection" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceGroup.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceGroup.xml index 1e1a8d5e87c..cd63f8c8cdb 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceGroup.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceGroup.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSourceGroup" FullName="System.ComponentModel.Design.Data.DataSourceGroup"> <TypeSignature Language="C#" Value="public abstract class DataSourceGroup" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implements the basic functionality required by a single data source at the EnvDTE.Project level.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="DataSources"> @@ -35,9 +42,12 @@ <ReturnType>System.ComponentModel.Design.Data.DataSourceDescriptorCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the collection of descriptors for the data sources in this group.</para> + </summary> </Docs> </Member> <Member MemberName="Image"> @@ -50,9 +60,15 @@ <ReturnType>System.Drawing.Bitmap</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.Drawing.Bitmap" /> image that represents the group is typically used in design-time pickers. The image may be null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the <see cref="T:System.Drawing.Bitmap" /> image that represents the group.</para> + </summary> </Docs> </Member> <Member MemberName="IsDefault"> @@ -65,9 +81,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the value indicating whether this group is the default group.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -80,10 +99,16 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The name of the group must be unique across all data sources groups at the EnvDTE.Project level.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the name of the group.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceGroupCollection.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceGroupCollection.xml index 22be38ad820..74fc385d358 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceGroupCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceGroupCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSourceGroupCollection" FullName="System.ComponentModel.Design.Data.DataSourceGroupCollection"> <TypeSignature Language="C#" Value="public class DataSourceGroupCollection : System.Collections.CollectionBase" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type-safe collection of <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> objects.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DataSourceGroupCollection" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Add"> @@ -38,10 +45,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceGroup" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> to the collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> to add to the collection.</param> </Docs> </Member> <Member MemberName="Contains"> @@ -57,10 +68,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceGroup" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.ComponentModel.Design.Data.DataSourceGroupCollection" /> contains the specified <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> to locate.</param> </Docs> </Member> <Member MemberName="CopyTo"> @@ -77,10 +92,15 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the <see cref="T:System.ComponentModel.Design.Data.DataSourceGroupCollection" /> values to a one-dimensional <see cref="T:System.Array" /> at the specified index.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional <see cref="T:System.Array" /> that is the destination of the values copied from the <see cref="T:System.ComponentModel.Design.Data.DataSourceGroupCollection" />.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The index in the <paramref name="array" /> where copying begins.</param> </Docs> </Member> <Member MemberName="IndexOf"> @@ -96,10 +116,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceGroup" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the index of a <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> in the <see cref="T:System.ComponentModel.Design.Data.DataSourceGroupCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> to locate.</param> </Docs> </Member> <Member MemberName="Insert"> @@ -116,10 +140,15 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceGroup" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts a <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> into the <see cref="T:System.ComponentModel.Design.Data.DataSourceGroupCollection" /> at the specified index.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index where <paramref name="value" /> should be inserted.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> to insert.</param> </Docs> </Member> <Member MemberName="Item"> @@ -154,10 +183,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.Data.DataSourceGroup" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes a specific <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> from the <see cref="T:System.ComponentModel.Design.Data.DataSourceGroupCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Data.DataSourceGroup" /> to remove from the <see cref="T:System.ComponentModel.Design.Data.DataSourceGroupCollection" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceProviderService.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceProviderService.xml index 67fe79fec33..daa56da46c6 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceProviderService.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DataSourceProviderService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSourceProviderService" FullName="System.ComponentModel.Design.Data.DataSourceProviderService"> <TypeSignature Language="C#" Value="public abstract class DataSourceProviderService" /> <AssemblyInfo> @@ -14,8 +15,11 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implements the basic functionality required of a service for providing access to a data source at the EnvDTE.Project level.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -26,8 +30,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DataSourceProviderService" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="AddDataSourceInstance"> @@ -44,11 +51,20 @@ <Parameter Name="dataSourceDescriptor" Type="System.ComponentModel.Design.Data.DataSourceDescriptor" /> </Parameters> <Docs> - <param name="host">To be added.</param> - <param name="dataSourceDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You should only call the <see cref="M:System.ComponentModel.Design.Data.DataSourceProviderService.AddDataSourceInstance(System.ComponentModel.Design.IDesignerHost,System.ComponentModel.Design.Data.DataSourceDescriptor)" /> method on data sources that are designable for example, if the<see cref="P:System.ComponentModel.Design.Data.DataSourceDescriptor.IsDesignable" /> value is true.</para> + <para>This method enables the service implementer to perform custom actions when a data source is added to the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, creates and returns an instance of the given data source, and adds it to the design surface.</para> + </summary> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />The designer host.</param> + <param name="dataSourceDescriptor"> + <attribution license="cc4" from="Microsoft" modified="false" />The data source.</param> </Docs> </Member> <Member MemberName="GetDataSources"> @@ -62,9 +78,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, retrieves the collection of data sources at the EnvDTE.Project level.</para> + </summary> </Docs> </Member> <Member MemberName="InvokeAddNewDataSource"> @@ -81,11 +100,16 @@ <Parameter Name="startPosition" Type="System.Windows.Forms.FormStartPosition" /> </Parameters> <Docs> - <param name="parentWindow">To be added.</param> - <param name="startPosition">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, invokes the <ui>Add New Data Source Wizard</ui>.</para> + </summary> + <param name="parentWindow"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent window.</param> + <param name="startPosition"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial position of a form.</param> </Docs> </Member> <Member MemberName="InvokeConfigureDataSource"> @@ -103,12 +127,18 @@ <Parameter Name="dataSourceDescriptor" Type="System.ComponentModel.Design.Data.DataSourceDescriptor" /> </Parameters> <Docs> - <param name="parentWindow">To be added.</param> - <param name="startPosition">To be added.</param> - <param name="dataSourceDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, invokes the <ui>Configure Data Source</ui> dialog box on the specified data source.</para> + </summary> + <param name="parentWindow"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent window.</param> + <param name="startPosition"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial position of a form.</param> + <param name="dataSourceDescriptor"> + <attribution license="cc4" from="Microsoft" modified="false" />The data source.</param> </Docs> </Member> <Member MemberName="NotifyDataSourceComponentAdded"> @@ -124,9 +154,13 @@ <Parameter Name="dsc" Type="System.Object" /> </Parameters> <Docs> - <param name="dsc">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, notifies the service that a component representing a data source was added to the design surface.</para> + </summary> + <param name="dsc"> + <attribution license="cc4" from="Microsoft" modified="false" />The data source component.</param> </Docs> </Member> <Member MemberName="SupportsAddNewDataSource"> @@ -139,9 +173,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the value indicating whether the service supports adding a new data source using <see cref="M:System.ComponentModel.Design.Data.DataSourceProviderService.InvokeAddNewDataSource(System.Windows.Forms.IWin32Window,System.Windows.Forms.FormStartPosition)" />.</para> + </summary> </Docs> </Member> <Member MemberName="SupportsConfigureDataSource"> @@ -154,10 +191,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the value indicating whether the service supports configuring data sources using <see cref="M:System.ComponentModel.Design.Data.DataSourceProviderService.InvokeConfigureDataSource(System.Windows.Forms.IWin32Window,System.Windows.Forms.FormStartPosition,System.ComponentModel.Design.Data.DataSourceDescriptor)" />.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataColumn.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataColumn.xml index 84a00b6b6a2..f4c0673491e 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataColumn.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataColumn.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataColumn" FullName="System.ComponentModel.Design.Data.DesignerDataColumn"> <TypeSignature Language="C#" Value="public sealed class DesignerDataColumn" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataColumn" /> class is one of several types that represent the schema of a data store at design-time. These schema items are made available to controls by designers implementing the <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface. Controls access schema objects by calling the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method of the interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a column of a table or view in the data store accessed through a data connection. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +31,18 @@ <Parameter Name="dataType" Type="System.Data.DbType" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="dataType">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.ComponentModel.Design.Data.DesignerDataColumn.#ctor(System.String,System.Data.DbType)" /> to set the <see cref="P:System.ComponentModel.Design.Data.DesignerDataColumn.Name" /> and <see cref="P:System.ComponentModel.Design.Data.DesignerDataColumn.DataType" /> properties. All other properties are set to their default values.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataColumn" /> class with the specified name and data type. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name identifying the column in the data store.</param> + <param name="dataType"> + <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.DbType" /> values.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -42,11 +57,20 @@ <Parameter Name="defaultValue" Type="System.Object" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="dataType">To be added.</param> - <param name="defaultValue">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.ComponentModel.Design.Data.DesignerDataColumn.#ctor(System.String,System.Data.DbType,System.Object)" /> constructor to set the <see cref="P:System.ComponentModel.Design.Data.DesignerDataColumn.Name" />, <see cref="P:System.ComponentModel.Design.Data.DesignerDataColumn.DataType" />, and <see cref="P:System.ComponentModel.Design.Data.DesignerDataColumn.DefaultValue" /> properties. All other properties are set to their default values.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataColumn" /> class with the specified name, data type, and default value. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name identifying the column in the data store.</param> + <param name="dataType"> + <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.DbType" /> values.</param> + <param name="defaultValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The default value of the column.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -67,17 +91,32 @@ <Parameter Name="length" Type="System.Int32" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="dataType">To be added.</param> - <param name="defaultValue">To be added.</param> - <param name="identity">To be added.</param> - <param name="nullable">To be added.</param> - <param name="primaryKey">To be added.</param> - <param name="precision">To be added.</param> - <param name="scale">To be added.</param> - <param name="length">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.ComponentModel.Design.Data.DesignerDataColumn.#ctor(System.String,System.Data.DbType,System.Object,System.Boolean,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32)" /> constructor to set all the properties of a <see cref="T:System.ComponentModel.Design.Data.DesignerDataColumn" /> object. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataColumn" /> class with the specified values. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name identifying the column in the data store.</param> + <param name="dataType"> + <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.DbType" /> values.</param> + <param name="defaultValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The default value of the column</param> + <param name="identity"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the field is the identity field of the data row; otherwise, false.</param> + <param name="nullable"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the field can be null in the data store; otherwise, false.</param> + <param name="primaryKey"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the field is the primary key of the data row; otherwise, false.</param> + <param name="precision"> + <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of digits used by a numeric data field.</param> + <param name="scale"> + <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of digits to the right of the decimal point in a numeric data field.</param> + <param name="length"> + <attribution license="cc4" from="Microsoft" modified="false" />The length of the data field, in bytes.</param> </Docs> </Member> <Member MemberName="DataType"> @@ -90,9 +129,12 @@ <ReturnType>System.Data.DbType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data type of the data column.</para> + </summary> </Docs> </Member> <Member MemberName="DefaultValue"> @@ -105,9 +147,12 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the default value of the data column.</para> + </summary> </Docs> </Member> <Member MemberName="Identity"> @@ -120,9 +165,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the data column is an identity column for the data row.</para> + </summary> </Docs> </Member> <Member MemberName="Length"> @@ -135,9 +183,12 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the length in bytes of the data column.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -150,9 +201,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the column in the data store.</para> + </summary> </Docs> </Member> <Member MemberName="Nullable"> @@ -165,9 +219,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the column can be null in the data store.</para> + </summary> </Docs> </Member> <Member MemberName="Precision"> @@ -180,9 +237,12 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of digits in a numeric data column.</para> + </summary> </Docs> </Member> <Member MemberName="PrimaryKey"> @@ -195,9 +255,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the column is part of the table's primary key.</para> + </summary> </Docs> </Member> <Member MemberName="Scale"> @@ -210,10 +273,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of digits to the right of the decimal point in a numeric column.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataConnection.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataConnection.xml index 8eb9050859f..d65d5cabbee 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataConnection.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataConnection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataConnection" FullName="System.ComponentModel.Design.Data.DesignerDataConnection"> <TypeSignature Language="C#" Value="public sealed class DesignerDataConnection" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object represents a connection to a data store in the design tool. Typically a <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object is returned as part of the <see cref="P:System.ComponentModel.Design.Data.IDataEnvironment.Connections" /> property, and is created either by reading the application's configuration file or by calling the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.BuildConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a connection to a data store in a design tool. This class cannot be inherited. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,11 +32,20 @@ <Parameter Name="connectionString" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="providerName">To be added.</param> - <param name="connectionString">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use this constructor to create <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> objects that are not created from the application's configuration file. When you use this constructor, the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property is set to false.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> class with the specified name, data provider, and connection string. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name associated with this connection.</param> + <param name="providerName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the provider object used to access the underlying data store</param> + <param name="connectionString"> + <attribution license="cc4" from="Microsoft" modified="false" />The string that specifies how to connect to the data store.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -45,12 +61,22 @@ <Parameter Name="isConfigured" Type="System.Boolean" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="providerName">To be added.</param> - <param name="connectionString">To be added.</param> - <param name="isConfigured">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use this constructor when you need to specify the value of the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property, such as when you are creating a <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object from information stored in the application's configuration file. The <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property is set to the value of the <paramref name="isConfigured" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> class with the specified name, data provider, and connection string, and indicates whether the connection was loaded from a configuration file. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name associated with this connection.</param> + <param name="providerName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the provider object used to access the underlying data store.</param> + <param name="connectionString"> + <attribution license="cc4" from="Microsoft" modified="false" />The string that specifies how to connect to the data store.</param> + <param name="isConfigured"> + <attribution license="cc4" from="Microsoft" modified="false" />true to indicate the connection was created from information stored in the application's configuration file; otherwise, false.</param> </Docs> </Member> <Member MemberName="ConnectionString"> @@ -63,9 +89,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.ConnectionString" /> property contains the connection string used by the application for connecting to the data store. You must use the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetDesignTimeConnection(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method to return a connection string suitable for use in the design environment.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the application connection string defined for the connection.</para> + </summary> </Docs> </Member> <Member MemberName="IsConfigured"> @@ -78,9 +110,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property will be true if the <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object was read from the application's configuration file, or if the <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object was written to the application's configuration file by the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.ConfigureConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection,System.String)" /> method.</para> + <para>When the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> is true, the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.Name" /> property is set to the name of the connection as defined in the <format type="text/html"><a href="b6ffbb2e-a4d1-410e-8f7e-9755e92c65de">connectionStrings Element (ASP.NET Settings Schema)</a></format> of the configuration file.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the connection information is in the application's configuration file.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -93,9 +132,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.Name" /> property contains the name that identifies a specific connection in an application configuration file or a list of data connections. When the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property is true, <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.Name" /> property is used as the name attribute in the <format type="text/html"><a href="b6ffbb2e-a4d1-410e-8f7e-9755e92c65de">connectionStrings</a></format> configuration element, or is returned from the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.ConfigureConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection,System.String)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the data connection.</para> + </summary> </Docs> </Member> <Member MemberName="ProviderName"> @@ -108,10 +153,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the provider used to access the underlying data store.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataParameter.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataParameter.xml index 57437b4015a..db8b30a1f88 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataParameter.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataParameter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataParameter" FullName="System.ComponentModel.Design.Data.DesignerDataParameter"> <TypeSignature Language="C#" Value="public sealed class DesignerDataParameter" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataParameter" /> class is one of several types that represent the schema of a data store at design-time. These schema items are made available to controls by designers implementing the <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface. Controls access schema objects by calling the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method of the interface.</para> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataParameter" /> class represents the parameters required to call a stored procedure in the data store. The <see cref="P:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Parameters" /> property contains a collection of <see cref="T:System.ComponentModel.Design.Data.DesignerDataParameter" /> objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a parameter for a stored procedure. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,11 +33,17 @@ <Parameter Name="direction" Type="System.Data.ParameterDirection" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="dataType">To be added.</param> - <param name="direction">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataParameter" /> class with the specified name, data type, and input/output semantics. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the parameter.</param> + <param name="dataType"> + <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.DbType" /> values.</param> + <param name="direction"> + <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.ParameterDirection" /> values.</param> </Docs> </Member> <Member MemberName="DataType"> @@ -42,9 +56,15 @@ <ReturnType>System.Data.DbType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Data.DesignerDataParameter.DataType" /> property contains the type of data required by the underlying data store.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the database type of the parameter.</para> + </summary> </Docs> </Member> <Member MemberName="Direction"> @@ -57,9 +77,15 @@ <ReturnType>System.Data.ParameterDirection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="P:System.ComponentModel.Design.Data.DesignerDataParameter.Direction" /> property to indicate whether a parameter is passed into a stored procedure, returned from a stored procedure, or both.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return-value parameter.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -72,10 +98,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the parameter.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataRelationship.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataRelationship.xml index 6326aebbd04..361e0ea7964 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataRelationship.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataRelationship.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataRelationship" FullName="System.ComponentModel.Design.Data.DesignerDataRelationship"> <TypeSignature Language="C#" Value="public sealed class DesignerDataRelationship" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents to the designer a relationship between two tables in the data source accessed through a data connection. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -26,12 +30,19 @@ <Parameter Name="childColumns" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="parentColumns">To be added.</param> - <param name="childTable">To be added.</param> - <param name="childColumns">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataRelationship" /> class with the specified name, parent column, and child relationship. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the relationship.</param> + <param name="parentColumns"> + <attribution license="cc4" from="Microsoft" modified="false" />The columns in the parent table that define the relationship.</param> + <param name="childTable"> + <attribution license="cc4" from="Microsoft" modified="false" />The child table in the relationship.</param> + <param name="childColumns"> + <attribution license="cc4" from="Microsoft" modified="false" />The columns in the child table that define the relationship.</param> </Docs> </Member> <Member MemberName="ChildColumns"> @@ -44,9 +55,12 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of columns from the child table that are part of the relationship.</para> + </summary> </Docs> </Member> <Member MemberName="ChildTable"> @@ -59,9 +73,12 @@ <ReturnType>System.ComponentModel.Design.Data.DesignerDataTable</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the child table referenced in the relationship.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -74,9 +91,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the relationship.</para> + </summary> </Docs> </Member> <Member MemberName="ParentColumns"> @@ -89,10 +109,13 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of columns from the parent table that are part of the relationship between two tables.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataSchemaClass.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataSchemaClass.xml index 5a679a86725..a4b599bf731 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataSchemaClass.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataSchemaClass.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataSchemaClass" FullName="System.ComponentModel.Design.Data.DesignerDataSchemaClass"> <TypeSignature Language="C#" Value="public sealed class DesignerDataSchemaClass" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> class is one of several types that represent the schema of a data store at design-time. These schema items are made available to controls by designers implementing the <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface. Controls access schema objects by calling the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method of the interface.</para> + <para>Use fields from the <see cref="T:System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> class when calling the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method to specify the types of objects you want to retrieve from a data-store schema. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the types of objects that can be retrieved from a data-store schema. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName="StoredProcedures"> @@ -23,8 +31,11 @@ <ReturnType>System.ComponentModel.Design.Data.DesignerDataSchemaClass</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates that stored procedures should be returned from the data-store schema.</para> + </summary> </Docs> </Member> <Member MemberName="Tables"> @@ -37,8 +48,11 @@ <ReturnType>System.ComponentModel.Design.Data.DesignerDataSchemaClass</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates that tables should be returned from the data-store schema.</para> + </summary> </Docs> </Member> <Member MemberName="Views"> @@ -51,9 +65,12 @@ <ReturnType>System.ComponentModel.Design.Data.DesignerDataSchemaClass</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates that data views should be returned from the data-store schema.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataStoredProcedure.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataStoredProcedure.xml index 8987bc9d9df..a46297ef0b6 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataStoredProcedure.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataStoredProcedure.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataStoredProcedure" FullName="System.ComponentModel.Design.Data.DesignerDataStoredProcedure"> <TypeSignature Language="C#" Value="public abstract class DesignerDataStoredProcedure" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataStoredProcedure" /> class is one of several types that represent the schema of a data store at design-time. These schema items are made available to controls by designers implementing the <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface. Controls access schema objects by calling the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method of the interface.</para> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataStoredProcedure" /> class represents a single table in the data store. A collection of <see cref="T:System.ComponentModel.Design.Data.DesignerDataStoredProcedure" /> objects is returned when you call the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method with the <paramref name="schemaClass" /> parameter set to <see cref="F:System.ComponentModel.Design.Data.DesignerDataSchemaClass.StoredProcedures" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a stored procedure in the data store.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +31,13 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataStoredProcedure" /> class with the specified name. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the stored procedure.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -39,10 +51,15 @@ <Parameter Name="owner" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="owner">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataStoredProcedure" /> class with the specified name and owner. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the stored procedure.</param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The data store owner of the stored procedure.</param> </Docs> </Member> <Member MemberName="CreateParameters"> @@ -56,9 +73,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.CreateParameters" /> method is called the first time the <see cref="P:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Parameters" /> property is accessed to populate the collection of stored-procedure parameters.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, returns a collection of parameters for the stored procedure.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -71,9 +94,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the stored procedure.</para> + </summary> </Docs> </Member> <Member MemberName="Owner"> @@ -86,9 +112,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the owner of the stored procedure.</para> + </summary> </Docs> </Member> <Member MemberName="Parameters"> @@ -101,10 +130,16 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Parameters" /> property is populated by the <see cref="M:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.CreateParameters" /> method the first time the <see cref="P:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Parameters" /> property is accessed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of parameters required for a stored procedure.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataTable.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataTable.xml index 43861bddc61..74ac59e81de 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataTable.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataTable.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataTable" FullName="System.ComponentModel.Design.Data.DesignerDataTable"> <TypeSignature Language="C#" Value="public abstract class DesignerDataTable : System.ComponentModel.Design.Data.DesignerDataTableBase" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataTable" /> class is one of several types that represent the schema of a data store at design-time. These schema items are made available to controls by designers implementing the <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface. Controls access schema objects by calling the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method of the interface.</para> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataTable" /> class represents a single table in the data store. A collection of <see cref="T:System.ComponentModel.Design.Data.DesignerDataTable" /> objects is returned when you call the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method with the <paramref name="schemaClass" /> parameter set to <see cref="F:System.ComponentModel.Design.Data.DesignerDataSchemaClass.Tables" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a table in the data store.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +31,13 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataTable" /> class with the specified name. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the table.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -39,10 +51,15 @@ <Parameter Name="owner" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="owner">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataTable" /> class with the specified name and owner. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the table.</param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The owner of the table.</param> </Docs> </Member> <Member MemberName="CreateRelationships"> @@ -56,9 +73,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Data.DesignerDataTable.CreateRelationships" /> method is called the first time the <see cref="P:System.ComponentModel.Design.Data.DesignerDataTable.Relationships" /> property is accessed, to populate the collection of data table relationships.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, returns a collection of relationship objects.</para> + </summary> </Docs> </Member> <Member MemberName="Relationships"> @@ -71,10 +94,16 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A relationship describes a link between two tables in a data store. The <see cref="P:System.ComponentModel.Design.Data.DesignerDataTable.Relationships" /> property returns a collection that represents all the relationships between this table and other tables in the data store.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of relationships defined for a table.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataTableBase.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataTableBase.xml index c02829841cb..63c8e738981 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataTableBase.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataTableBase.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataTableBase" FullName="System.ComponentModel.Design.Data.DesignerDataTableBase"> <TypeSignature Language="C#" Value="public abstract class DesignerDataTableBase" /> <AssemblyInfo> @@ -9,8 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataTableBase" /> class is one of several types that represent the schema of a data store at design-time. These schema items are made available to controls by designers implementing the <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface. Controls access schema objects by calling the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method of the interface.</para> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataTableBase" /> class provides the properties and methods shared between data tables in a data store and views defined on those data tables. </para> + <para>When you inherit from the <see cref="T:System.ComponentModel.Design.Data.DesignerDataTableBase" /> class, you must override the <see cref="M:System.ComponentModel.Design.Data.DesignerDataTableBase.CreateColumns" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines the properties and methods shared between data-store tables and data-store views.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +32,16 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the class for use by an inherited class instance. This constructor can be called only by an inherited class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataTableBase" /> class. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the table or view.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -39,10 +55,18 @@ <Parameter Name="owner" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="owner">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the class for use by an inherited class instance. This constructor can be called only by an inherited class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataTableBase" /> class. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the table or view.</param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The data-store owner of the table or view.</param> </Docs> </Member> <Member MemberName="Columns"> @@ -55,9 +79,15 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Data.DesignerDataTableBase.Columns" /> property is populated by the <see cref="M:System.ComponentModel.Design.Data.DesignerDataTableBase.CreateColumns" /> method the first time the <see cref="P:System.ComponentModel.Design.Data.DesignerDataTableBase.Columns" /> property is accessed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of columns defined for a table or view.</para> + </summary> </Docs> </Member> <Member MemberName="CreateColumns"> @@ -71,9 +101,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Data.DesignerDataTableBase.CreateColumns" /> method is called the first time the <see cref="P:System.ComponentModel.Design.Data.DesignerDataTableBase.Columns" /> property is accessed, to populate the collection of data-store columns.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, returns a collection of data-store column objects.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -86,9 +122,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the data-store table or view.</para> + </summary> </Docs> </Member> <Member MemberName="Owner"> @@ -101,10 +140,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the owner of the data-store table or view.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataView.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataView.xml index f568a524389..8880ca04076 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataView.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/DesignerDataView.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataView" FullName="System.ComponentModel.Design.Data.DesignerDataView"> <TypeSignature Language="C#" Value="public abstract class DesignerDataView : System.ComponentModel.Design.Data.DesignerDataTableBase" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataView" /> class is one of several types that represent the schema of a data store at design-time. These schema items are made available to controls by designers implementing the <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface. Controls access schema objects by calling the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method of the interface.</para> + <para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataView" /> class represents a single data view in the data store. A collection of <see cref="T:System.ComponentModel.Design.Data.DesignerDataView" /> objects is returned when you call the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method with the <paramref name="schemaClass" /> parameter set to <see cref="F:System.ComponentModel.Design.Data.DesignerDataSchemaClass.Views" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a data view in the data store.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +31,13 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataView" /> class with the specified name. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the view.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -39,11 +51,16 @@ <Parameter Name="owner" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="owner">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataView" /> class with the specified name and owner. </para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the view.</param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The data-store owner of the view.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/IDataEnvironment.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/IDataEnvironment.xml index 00eda059407..f11742066d4 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/IDataEnvironment.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/IDataEnvironment.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDataEnvironment" FullName="System.ComponentModel.Design.Data.IDataEnvironment"> <TypeSignature Language="C#" Value="public interface IDataEnvironment" /> <AssemblyInfo> @@ -6,8 +7,15 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An object that implements the <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface can access the data connections available to an application at design time. The <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface provides methods to list available data connections, create new data connections, retrieve schema information from a connection, and save data-connection configuration information to the application's configuration file.</para> + <para>The <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> interface enables you to interact with data connections in the design environment, but it is not intended as a data-management API.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines an interface to data services that enables control designers to integrate data store or database-related functionality into their design environment.</para> + </summary> </Docs> <Members> <Member MemberName="BuildConnection"> @@ -24,11 +32,22 @@ <Parameter Name="initialConnection" Type="System.ComponentModel.Design.Data.DesignerDataConnection" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="initialConnection">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.BuildConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection)" /> method to activate the design environment's user interface for creating or editing data connections. If the <paramref name="initialConnection" /> parameter is null, it indicates the user wants to create a new connection. If the <paramref name="initialConnection" /> parameter is a <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object, it indicates the user wants to edit an existing connection.</para> + <para>Your design environment is responsible for creating the data connection, adding the connection either to a global list of connections or to the Web application's configuration file, and adding the new connection to the <see cref="P:System.ComponentModel.Design.Data.IDataEnvironment.Connections" /> property.</para> + <para>The new connection should include the information that the application needs to create a data connection at run time. If you need to use the data connection in the design environment, use the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetDesignTimeConnection(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method to return a <see cref="T:System.Data.Common.DbConnection" /> object that will connect to the data store from the design environment.</para> + <para>If the user chooses to cancel the new connection creation process, the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.BuildConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection)" /> method should return null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new data connection or edits an existing connection using the design tool's new connection user interface.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent window for the connection dialog.</param> + <param name="initialConnection"> + <attribution license="cc4" from="Microsoft" modified="false" />The connection, if any, to edit. To create a new connection, <paramref name="initialConnection" /> should be null.</param> </Docs> </Member> <Member MemberName="BuildQuery"> @@ -47,13 +66,24 @@ <Parameter Name="initialQueryText" Type="System.String" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="connection">To be added.</param> - <param name="mode">To be added.</param> - <param name="initialQueryText">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.BuildQuery(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection,System.ComponentModel.Design.Data.QueryBuilderMode,System.String)" /> method launches the design environment's UI for editing or creating SQL query strings. If the <paramref name="initialQueryText" /> parameter is <see cref="F:System.String.Empty" />, it indicates the user wants to create a new query. If the <paramref name="initialQueryText" /> parameter contains a string, it indicates the user wants to edit the existing query. </para> + <para>The <paramref name="mode" /> parameter indicates the type of query the user wants to build; either select, update, insert, or delete. Your user interface can use the <paramref name="mode" /> parameter to configure itself for the type of query desired, limit the user to using SQL statements valid only for the type of query desired, and/or validate the query against the desired type.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Launches a dialog to build a SQL query string.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent window for the dialog.</param> + <param name="connection"> + <attribution license="cc4" from="Microsoft" modified="false" />The data connection to use for the query.</param> + <param name="mode"> + <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.ComponentModel.Design.Data.QueryBuilderMode" /> values.</param> + <param name="initialQueryText"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial value of the query or <see cref="F:System.String.Empty" /> to create a new query.</param> </Docs> </Member> <Member MemberName="ConfigureConnection"> @@ -71,12 +101,64 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="connection">To be added.</param> - <param name="name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.ConfigureConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection,System.String)" /> method writes a connection to the application's configuration file. The connection string and provider name are written to the <format type="text/html"><a href="b6ffbb2e-a4d1-410e-8f7e-9755e92c65de">connectionStrings</a></format> configuration element named according to the <paramref name="name" /> parameter. The <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.Name" /> property of the <paramref name="connection" /> parameter is ignored. </para> + <para>Implementations of the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.ConfigureConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection,System.String)" /> method should throw the following exceptions.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Exception</para> + </term> + <description> + <para>Reason</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ArgumentException" /> + </para> + </term> + <description> + <para>A duplicate name exists in the application's configuration file.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.IO.FileNotFoundException" />, <see cref="T:System.UnauthorizedAccessException" />, or other appropriate file IO exception.</para> + </term> + <description> + <para>The application's configuration file cannot be updated. Your <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.ConfigureConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection,System.String)" /> method implementation should throw an appropriate exception.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.CheckoutException" /> + </para> + </term> + <description> + <para>The application's configuration file cannot be checked out from the source control system.</para> + </description> + </item> + </list> + <para>Consider using the configuration-management APIs in the <see cref="N:System.Configuration" /> namespace to read and write the application's configuration file. The <see cref="T:System.Configuration.ConnectionStringsSection" /> class will read and write the <format type="text/html"><a href="b6ffbb2e-a4d1-410e-8f7e-9755e92c65de">connectionStrings</a></format> configuration element.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Writes a connection string to the application's configuration file.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent window for the dialog, if any.</param> + <param name="connection"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object containing the connection data to save.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the new connection configuration entry.</param> </Docs> </Member> <Member MemberName="Connections"> @@ -89,9 +171,16 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Data.IDataEnvironment.Connections" /> property returns the set of connections available at design time. Your implementation of the <see cref="P:System.ComponentModel.Design.Data.IDataEnvironment.Connections" /> property can return either the list of connections defined in the current Web application, or a list of connections defined at a global level, such as a list of data connections maintained by the design environment.</para> + <para>Each connection in the collection should have a unique connection string. If your collection includes both connections from the application's configuration file and global connections, your implementation must handle the case where connections from the global list and the configuration file have the same connection string. In this case, it is recommended that you eliminate duplicates and use the configuration-file connection only.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of data connections defined in the current design session.</para> + </summary> </Docs> </Member> <Member MemberName="GetCodeExpression"> @@ -107,10 +196,14 @@ <Parameter Name="connection" Type="System.ComponentModel.Design.Data.DesignerDataConnection" /> </Parameters> <Docs> - <param name="connection">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a code expression that contains the source code required to retrieve a connection string from the application's configuration file.</para> + </summary> + <param name="connection"> + <attribution license="cc4" from="Microsoft" modified="false" />The connection to retrieve from the application's configuration file.</param> </Docs> </Member> <Member MemberName="GetConnectionSchema"> @@ -126,10 +219,17 @@ <Parameter Name="connection" Type="System.ComponentModel.Design.Data.DesignerDataConnection" /> </Parameters> <Docs> - <param name="connection">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method returns the database schema for the specified data connection. If the schema is unavailable, or if the provider for the connection is unavailable, the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema(System.ComponentModel.Design.Data.DesignerDataConnection)" /> should return null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the schema for the specified data connection.</para> + </summary> + <param name="connection"> + <attribution license="cc4" from="Microsoft" modified="false" />The data connection for which to return schema information.</param> </Docs> </Member> <Member MemberName="GetDesignTimeConnection"> @@ -145,11 +245,19 @@ <Parameter Name="connection" Type="System.ComponentModel.Design.Data.DesignerDataConnection" /> </Parameters> <Docs> - <param name="connection">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetDesignTimeConnection(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method returns a valid, open connection to the data store that can be used by the control designer. </para> + <para>Control designers should use the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetDesignTimeConnection(System.ComponentModel.Design.Data.DesignerDataConnection)" /> to obtain a data connection and should not attempt to open a connection using the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.ConnectionString" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a database connection that can be used at design time.</para> + </summary> + <param name="connection"> + <attribution license="cc4" from="Microsoft" modified="false" />The desired data connection.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/IDesignerDataSchema.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/IDesignerDataSchema.xml index 269fe442cfb..6bc4a3f744d 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/IDesignerDataSchema.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/IDesignerDataSchema.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDesignerDataSchema" FullName="System.ComponentModel.Design.Data.IDesignerDataSchema"> <TypeSignature Language="C#" Value="public interface IDesignerDataSchema" /> <AssemblyInfo> @@ -6,8 +7,15 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Classes that implement the <see cref="T:System.ComponentModel.Design.Data.IDesignerDataSchema" /> interface retrieve schema information from a data store and return it to the user interface, typically to populate UI elements that enable the user to specify the data-store object that they want to work with.</para> + <para>The <see cref="T:System.ComponentModel.Design.Data.IDesignerDataSchema" /> interface provides two methods: the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method, which returns the requested schema objects, and the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.SupportsSchemaClass(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method, which indicates whether a specified data-schema object is supported by the data store. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines methods for retrieving data-store schema information.</para> + </summary> </Docs> <Members> <Member MemberName="GetSchemaItems"> @@ -23,10 +31,20 @@ <Parameter Name="schemaClass" Type="System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> </Parameters> <Docs> - <param name="schemaClass">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method returns a collection of all the specified schema objects in the data store. </para> + <para>See the <see cref="T:System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> class for the list of schema objects supported by the .NET Framework. Additional schema objects can be added to the <see cref="T:System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> class by creating a derived type.</para> + <para>If the data store does not support the requested schema object, the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method should return null. You can use the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.SupportsSchemaClass(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method to determine whether a data store supports the requested schema object before calling the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method, to avoid returning null to your application.</para> + <para>If the data store supports the requested object, but does not contain any instances, the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method should return an empty collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of specified schema items.</para> + </summary> + <param name="schemaClass"> + <attribution license="cc4" from="Microsoft" modified="false" />The schema objects to return.</param> </Docs> </Member> <Member MemberName="SupportsSchemaClass"> @@ -42,11 +60,19 @@ <Parameter Name="schemaClass" Type="System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> </Parameters> <Docs> - <param name="schemaClass">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.SupportsSchemaClass(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method indicates whether the data store supports a specified data-schema object. If the data store does not support the specified object, the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.SupportsSchemaClass(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method should return false.</para> + <para>You can add tests for additional data-schema objects by deriving from the <see cref="T:System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value indicating whether the data store contains the specified data-schema object.</para> + </summary> + <param name="schemaClass"> + <attribution license="cc4" from="Microsoft" modified="false" />The schema objects to return.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/QueryBuilderMode.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/QueryBuilderMode.xml index a0acb410b33..5fe1f3e98b9 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/QueryBuilderMode.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/QueryBuilderMode.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="QueryBuilderMode" FullName="System.ComponentModel.Design.Data.QueryBuilderMode"> <TypeSignature Language="C#" Value="public enum QueryBuilderMode" /> <AssemblyInfo> @@ -8,8 +9,14 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Data.QueryBuilderMode" /> enumeration is used when you call the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.BuildQuery(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection,System.ComponentModel.Design.Data.QueryBuilderMode,System.String)" /> method to indicate the type of query desired.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the type of data-store query the design environment should construct.</para> + </summary> </Docs> <Members> <Member MemberName="Delete"> @@ -22,7 +29,10 @@ <ReturnType>System.ComponentModel.Design.Data.QueryBuilderMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The query being built is a Delete query.</para> + </summary> </Docs> </Member> <Member MemberName="Insert"> @@ -35,7 +45,10 @@ <ReturnType>System.ComponentModel.Design.Data.QueryBuilderMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The query being built is an Insert query.</para> + </summary> </Docs> </Member> <Member MemberName="Select"> @@ -48,7 +61,10 @@ <ReturnType>System.ComponentModel.Design.Data.QueryBuilderMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The query being built is a Select query.</para> + </summary> </Docs> </Member> <Member MemberName="Update"> @@ -61,8 +77,11 @@ <ReturnType>System.ComponentModel.Design.Data.QueryBuilderMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The query being built is an Update query.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/BasicDesignerLoader.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/BasicDesignerLoader.xml index 6281f4432cb..2003df2c3d0 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/BasicDesignerLoader.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/BasicDesignerLoader.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BasicDesignerLoader" FullName="System.ComponentModel.Design.Serialization.BasicDesignerLoader"> <TypeSignature Language="C#" Value="public abstract class BasicDesignerLoader : System.ComponentModel.Design.Serialization.DesignerLoader, System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> <AssemblyInfo> @@ -13,8 +14,59 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> is a complete implementation of a designer loader without anything relating to a persistence format. A <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> does not dictate either a text or binary persistence, but it does support the following features:</para> + <list type="bullet"> + <item> + <para>Multiple load dependencies.</para> + </item> + <item> + <para>Tracking changes within the designer.</para> + </item> + <item> + <para>Deferred idle-time reloading.</para> + </item> + </list> + <para>A <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> adds two kinds of services to the designer host’s service container: replaceable services and irreplaceable services. You can replace a replaceable service by changing the value of the protected <see cref="P:System.ComponentModel.Design.Serialization.BasicDesignerLoader.LoaderHost" /> property. You cannot replace irreplaceable services because their implementations depend on each other.</para> + <para>The following table describes the services that are provided by default.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Default Service</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> + </para> + </term> + <description> + <para>Allows objects to request that the designer reload itself when it is idle. This is a replaceable service.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> + </para> + </term> + <description> + <para>Used to serialize and deserialize objects. The serialization manager is added as a service so objects that need to perform serialization can utilize any serialization providers that were added to the serialization manager. This is an irreplaceable service.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an implementation of the <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> interface.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,8 +77,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="BeginLoad"> @@ -42,9 +97,28 @@ <Parameter Name="host" Type="System.ComponentModel.Design.Serialization.IDesignerLoaderHost" /> </Parameters> <Docs> - <param name="host">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This is an implementation of the abstract <see cref="M:System.ComponentModel.Design.Serialization.DesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> method. You do not need to override this method in your own class. The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> method performs the following actions:</para> + <list type="bullet"> + <item> + <para>It verifies that the design surface has not already loaded.</para> + </item> + <item> + <para>On the first call, it adds relevant services and calls the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Initialize" /> method.</para> + </item> + <item> + <para>It calls the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginLoad" />, <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.PerformLoad(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" />, and <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" /> methods.</para> + </item> + </list> + <para>If the designer loader service has not been removed from the service container, <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> will call the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.System#ComponentModel#Design#Serialization#IDesignerLoaderService#AddLoadDependency" /> and <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.System#ComponentModel#Design#Serialization#IDesignerLoaderService#DependentLoadComplete(System.Boolean,System.Collections.ICollection)" /> methods instead of the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginLoad" /> and <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" /> methods. In this situation, it is the responsibility of the designer loader service to call <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginLoad" /> and <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Starts the loading process.</para> + </summary> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />The designer loader host to load.</param> </Docs> </Member> <Member MemberName="Dispose"> @@ -58,8 +132,18 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Calling the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Dispose" /> method does not flush changes to the designer loader. If you want changes to be saved, call <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Flush" /> before calling <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Dispose" />.</para> + <para>Call <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Dispose" /> when you are finished using the <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" />. The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Dispose" /> method leaves the <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> in an unusable state. After calling <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Dispose" />, you must release all references to the <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> 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.Serialization.BasicDesignerLoader.Dispose" /> before you release your last reference to the <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> object's Finalize method.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the resources used by the <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" />.</para> + </summary> </Docs> </Member> <Member MemberName="EnableComponentNotification"> @@ -75,10 +159,14 @@ <Parameter Name="enable" Type="System.Boolean" /> </Parameters> <Docs> - <param name="enable">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enables or disables component notification with the <see cref="T:System.ComponentModel.Design.Serialization.DesignerLoader" />.</para> + </summary> + <param name="enable"> + <attribution license="cc4" from="Microsoft" modified="false" />true to enable component notification by the <see cref="T:System.ComponentModel.Design.Serialization.DesignerLoader" />; false to disable component notification by the <see cref="T:System.ComponentModel.Design.Serialization.DesignerLoader" />.</param> </Docs> </Member> <Member MemberName="Flush"> @@ -92,8 +180,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the designer loader has not been loaded or has not been marked as modified, the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Flush" /> method returns immediately. Otherwise, <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Flush" /> asks the serialization manager to create a serialization session and then calls <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.PerformFlush(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Flushes pending changes to the designer loader.</para> + </summary> </Docs> </Member> <Member MemberName="GetService"> @@ -109,10 +203,18 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.GetService(System.Type)" /> is a helper method that allows classes deriving from <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> to access services offered by the designer loader host.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the requested service.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the service.</param> </Docs> </Member> <Member MemberName="Initialize"> @@ -126,8 +228,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Initialize" /> method is called the first time <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> is invoked. You can add any services necessary to the designer loader host at this time. The base implementation adds services that <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> provides, so after calling the base implementation you may replace existing services. You must remove any custom services you add here by overriding <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Dispose" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes services.</para> + </summary> </Docs> </Member> <Member MemberName="IsReloadNeeded"> @@ -141,9 +249,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.IsReloadNeeded" /> method is used by some designer loaders to optimize reloading. This method can be overridden if your designer loader supports intelligent reloading. Some designer loaders can detect changes made to their underlying document and determine if a reload of the designer is actually necessary. If not, they should return false from this method. The default implementation always returns true, indicating that any call to <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Reload(System.ComponentModel.Design.Serialization.BasicDesignerLoader.ReloadOptions)" /> will succeed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the designer should be reloaded.</para> + </summary> </Docs> </Member> <Member MemberName="LoaderHost"> @@ -156,9 +270,15 @@ <ReturnType>System.ComponentModel.Design.Serialization.IDesignerLoaderHost</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method returns the loader host that was given to this designer loader. This can be null if <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> has not been called yet, or if this designer loader has been disposed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the loader host.</para> + </summary> </Docs> </Member> <Member MemberName="Loading"> @@ -171,9 +291,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> class provides the <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" />, which supports load dependencies. This property takes load dependencies into account and will return true if there are any outstanding load dependencies.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the designer loader is loading the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="Modified"> @@ -186,9 +312,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines if the designer loader has detected that the designer has been modified. If this property is true when the designer loader’s <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Flush" /> method is called, the designer loader will call the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.PerformFlush(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value indicating whether the designer has been modified.</para> + </summary> </Docs> </Member> <Member MemberName="OnBeginLoad"> @@ -202,8 +334,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginLoad" /> method is invoked to start the loading process. You should perform any necessary initialization for loading at this time. This method should not be used to perform the actual load. The default implementation disables change notifications and sets up the <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> for loading.</para> + <para>If you implement <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> to provide dependent load support, you should call <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginLoad" /> when the first dependent load occurs. Call the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" /> method after the last call to the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.System#ComponentModel#Design#Serialization#IDesignerLoaderService#DependentLoadComplete(System.Boolean,System.Collections.ICollection)" /> method. By default, <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> implements <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> and does this for you. If <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> is not available when <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> is called, <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> will directly call <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginLoad" />.</para> + <para>If you provide your own loader service, or if you choose not to provide a loader service, you are responsible for calling this method. The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> method will automatically call this, either indirectly by calling <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.System#ComponentModel#Design#Serialization#IDesignerLoaderService#AddLoadDependency" /> if <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> is available, or directly if it is not.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the designer loader that loading is about to begin.</para> + </summary> </Docs> </Member> <Member MemberName="OnBeginUnload"> @@ -217,8 +357,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginUnload" /> method is invoked when the designer loader is about to unload the document.</para> + <para>The document may be unloaded in preparation for reloading, or if the document failed to load. If you added document-specific services in <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginLoad" /> or <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" />, remove them here.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the designer loader that unloading is about to begin.</para> + </summary> </Docs> </Member> <Member MemberName="OnEndLoad"> @@ -235,10 +382,20 @@ <Parameter Name="errors" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="successful">To be added.</param> - <param name="errors">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" /> method is invoked when loading is finished. It is always called, even if an exception is thrown during loading. The value of <paramref name="successful" /> will be set to true if the load succeeded, or false if a fatal error occurred. The <paramref name="errors" /> collection will contain objects that were reported as errors. Usually, these objects are exceptions.</para> + <para>If you implement <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> to provide dependent load support, you should call the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" /> method after the last call to the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.System#ComponentModel#Design#Serialization#IDesignerLoaderService#DependentLoadComplete(System.Boolean,System.Collections.ICollection)" /> method. By default, <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" /> implements <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> and does this for you. If <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> is not available when <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> is called, <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> will directly call <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" /> after calling <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.PerformLoad(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" />.</para> + <para>This method should be called by the designer loader service when all dependent loads have been completed. This stops the loading process that was initiated by the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> method. If you provide your own loader service, or if you choose not to provide a loader service, you are responsible for calling this method. The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.BeginLoad(System.ComponentModel.Design.Serialization.IDesignerLoaderHost)" /> method will automatically call this, either indirectly by calling the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.System#ComponentModel#Design#Serialization#IDesignerLoaderService#DependentLoadComplete(System.Boolean,System.Collections.ICollection)" /> method if <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" /> is available, or directly if it is not.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the designer loader that loading is complete.</para> + </summary> + <param name="successful"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the load completed successfully; otherwise, false.</param> + <param name="errors"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ICollection" /> containing objects (usually exceptions) that were reported as errors.</param> </Docs> </Member> <Member MemberName="OnModifying"> @@ -252,8 +409,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnModifying" /> method is called in response to a component changing, adding, or removing event which indicates that the designer is about to be modified. You can implement source code control by overriding this method. A call to <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnModifying" /> does not mean that the <see cref="P:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Modified" /> property will later be set to true; it merely indicates an intention to do so.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the designer loader that the state of the document is about to be modified.</para> + </summary> </Docs> </Member> <Member MemberName="PerformFlush"> @@ -269,9 +432,16 @@ <Parameter Name="serializationManager" Type="System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> </Parameters> <Docs> - <param name="serializationManager">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.PerformFlush(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> method is invoked when the designer loader needs to flush to persistence any changes made to the designers. It is invoked in response to a call to the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Flush" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Flushes all changes to the designer.</para> + </summary> + <param name="serializationManager"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for persisting the state of loaded designers.</param> </Docs> </Member> <Member MemberName="PerformLoad"> @@ -287,9 +457,16 @@ <Parameter Name="serializationManager" Type="System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> </Parameters> <Docs> - <param name="serializationManager">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.PerformLoad(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> method is invoked when the designer loader needs to load its state. <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.PerformLoad(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> is called before the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginLoad" /> method. You must implement this method to load the designer contents.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Loads a designer from persistence.</para> + </summary> + <param name="serializationManager"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for loading state for the designers.</param> </Docs> </Member> <Member MemberName="PropertyProvider"> @@ -302,9 +479,15 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The serialization manager provides a Properties property on its primary interface that can be read by serializers to customize their serialization to specific needs. The properties that are examined by the serializers vary depending on the type of serializer used.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the property provider for the serialization manager being used by the loader.</para> + </summary> </Docs> </Member> <Member MemberName="Reload"> @@ -335,9 +518,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether a reload has been queued.</para> + </summary> </Docs> </Member> <Member MemberName="ReportFlushErrors"> @@ -353,9 +539,16 @@ <Parameter Name="errors" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="errors">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.ReportFlushErrors(System.Collections.ICollection)" /> method is called during <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.Flush" /> if one or more errors occurred while flushing changes. The values in the <paramref name="errors" /> collection can be exceptions or objects with <see cref="M:System.Object.ToString" /> values that describe the error. The default implementation of <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.ReportFlushErrors(System.Collections.ICollection)" /> raises the last exception in the collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Reports errors that occurred while flushing changes.</para> + </summary> + <param name="errors"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ICollection" /> containing error objects, usually exceptions.</param> </Docs> </Member> <Member MemberName="SetBaseComponentClassName"> @@ -371,9 +564,16 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.SetBaseComponentClassName(System.String)" /> method should be called during loading to establish the full name of the component a designer is designing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the full class name of the base component.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />A string representing the full name of the component to be designed.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerLoaderService.AddLoadDependency"> @@ -387,8 +587,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerLoaderService.AddLoadDependency" /> method once for each external object participating in the load process. The <see cref="M:System.ComponentModel.Design.Serialization.IDesignerLoaderService.DependentLoadComplete(System.Boolean,System.Collections.ICollection)" /> method is called when the work of the load process is done.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Registers an external component as part of the load process managed by <see cref="T:System.ComponentModel.Design.Serialization.IDesignerLoaderService" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerLoaderService.DependentLoadComplete"> @@ -405,10 +611,19 @@ <Parameter Name="errorCollection" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="successful">To be added.</param> - <param name="errorCollection">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.System#ComponentModel#Design#Serialization#IDesignerLoaderService#DependentLoadComplete(System.Boolean,System.Collections.ICollection)" /> method is called to signal that a dependent loading operation has completed. Call the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerLoaderService.DependentLoadComplete(System.Boolean,System.Collections.ICollection)" /> method once for every process that was registered by calling the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerLoaderService.AddLoadDependency" /> method, which has already completed.</para> + <para>If the dependent load succeeds, the caller sets the <paramref name="successful" /> parameter to true and passes either an empty collection or null to the <paramref name="errorCollection" /> parameter. If the dependent load encounters errors, the caller sets the <paramref name="successful" /> parameter to false and passes a collection of exceptions that indicate the reason or reasons for failure to the <paramref name="errorCollection" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Signals that a dependent load has finished.</para> + </summary> + <param name="successful"> + <attribution license="cc4" from="Microsoft" modified="false" />true to load successfully; otherwise, false.</param> + <param name="errorCollection"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ICollection" /> containing errors that occurred during the load.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerLoaderService.Reload"> @@ -422,10 +637,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Any object can call the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.System#ComponentModel#Design#Serialization#IDesignerLoaderService#Reload" /> method to request that the loader reload the design document. If the loader supports reloading and complies with the reload, the designer loader can return true. Otherwise, it returns false, indicating that the reload will not occur. Callers cannot rely on the reload happening immediately; the designer loader can schedule this for some other time, or it can try to reload the designer at once.</para> + <para>The caller can display a message to the user if the designer cannot be reloaded.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Reloads the design document.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomComponentSerializationService.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomComponentSerializationService.xml index 132d70626cf..05d78549630 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomComponentSerializationService.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomComponentSerializationService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CodeDomComponentSerializationService" FullName="System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService"> <TypeSignature Language="C#" Value="public sealed class CodeDomComponentSerializationService : System.ComponentModel.Design.Serialization.ComponentSerializationService" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService" /> class serializes a set of components or serializable objects into a serialization store. The store can then be deserialized at a later time. The <see cref="T:System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService" /> class differs from other serialization schemes in that the serialization format is opaque, and it allows for partial serialization of objects. For example, you can choose to serialize only selected properties for an object.</para> + <para>The base class, <see cref="T:System.ComponentModel.Design.Serialization.ComponentSerializationService" />, replaces the <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationService" /> interface from the .NET Framework version 1.0, although the latter is retained for backward compatibility. The <see cref="T:System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService" /> class does not implement the <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationService" /> interface, but if you query for <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationService" />, the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> provides a bridge implementation to ensure backward compatibility.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes a set of components into a serialization store.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +29,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService" /> class. </para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -35,9 +46,13 @@ <Parameter Name="provider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="provider">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService" /> class using the given service provider to resolve services.</para> + </summary> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> to use for resolving services.</param> </Docs> </Member> <Member MemberName="CreateStore"> @@ -51,9 +66,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The serialization store can be passed to any of the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService.Serialize(System.ComponentModel.Design.Serialization.SerializationStore,System.Object)" /> methods to build up serialization state for a group of objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" />.</para> + </summary> </Docs> </Member> <Member MemberName="Deserialize"> @@ -69,10 +90,14 @@ <Parameter Name="store" Type="System.ComponentModel.Design.Serialization.SerializationStore" /> </Parameters> <Docs> - <param name="store">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes the given store to produce a collection of objects.</para> + </summary> + <param name="store"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> from which objects will be deserialized.</param> </Docs> </Member> <Member MemberName="Deserialize"> @@ -89,11 +114,19 @@ <Parameter Name="container" Type="System.ComponentModel.IContainer" /> </Parameters> <Docs> - <param name="store">To be added.</param> - <param name="container">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Created objects that implement the <see cref="T:System.ComponentModel.IComponent" /> interface will be added to the <paramref name="container" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes the given store and populates the given <see cref="T:System.ComponentModel.IContainer" /> with deserialized <see cref="T:System.ComponentModel.IComponent" /> objects.</para> + </summary> + <param name="store"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> from which objects will be deserialized.</param> + <param name="container"> + <attribution license="cc4" from="Microsoft" modified="false" />A container to which <see cref="T:System.ComponentModel.IComponent" /> objects will be added.</param> </Docs> </Member> <Member MemberName="DeserializeTo"> @@ -112,12 +145,22 @@ <Parameter Name="applyDefaults" Type="System.Boolean" /> </Parameters> <Docs> - <param name="store">To be added.</param> - <param name="container">To be added.</param> - <param name="validateRecycledTypes">To be added.</param> - <param name="applyDefaults">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService.DeserializeTo(System.ComponentModel.Design.Serialization.SerializationStore,System.ComponentModel.IContainer,System.Boolean,System.Boolean)" /> method deserializes the given store, but rather than producing new objects, the data in the store is applied to an existing set of objects that are taken from the <paramref name="container" /> parameter. As a result, the caller can create in advance an object however it sees fit. If an object has deserialization state and the object is not named in the set of existing objects, a new object will be created. If that object also implements <see cref="T:System.ComponentModel.IComponent" />, it will be added to the given container. Objects in the container must have names and types that match objects in the serialization store in order for an existing object to be used.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes the given <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> to the given container, optionally applying default property values.</para> + </summary> + <param name="store"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> from which the objects will be deserialized.</param> + <param name="container"> + <attribution license="cc4" from="Microsoft" modified="false" />A container of objects to which data will be applied.</param> + <param name="validateRecycledTypes"> + <attribution license="cc4" from="Microsoft" modified="false" />true to validate the recycled type; otherwise, false.</param> + <param name="applyDefaults"> + <attribution license="cc4" from="Microsoft" modified="false" />true to apply default property values; otherwise, false.</param> </Docs> </Member> <Member MemberName="LoadStore"> @@ -133,10 +176,17 @@ <Parameter Name="stream" Type="System.IO.Stream" /> </Parameters> <Docs> - <param name="stream">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You can use the returned store to deserialize objects by passing it to the various <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService.Deserialize" /> methods.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Loads a <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> from the given stream.</para> + </summary> + <param name="stream"> + <attribution license="cc4" from="Microsoft" modified="false" />The stream from which to load the <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" />.</param> </Docs> </Member> <Member MemberName="Serialize"> @@ -153,10 +203,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="store">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <paramref name="store" /> parameter can be used to serialize more than one object by calling this method once for each object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given object to the given <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" />.</para> + </summary> + <param name="store"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> to which <paramref name="value" /> will be serialized. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> </Docs> </Member> <Member MemberName="SerializeAbsolute"> @@ -173,10 +231,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="store">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The store can be used to serialize more than one object by calling this method more than once.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given object, accounting for default property values.</para> + </summary> + <param name="store"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> to which <paramref name="value" /> will be serialized. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> </Docs> </Member> <Member MemberName="SerializeMember"> @@ -194,11 +260,20 @@ <Parameter Name="member" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="store">To be added.</param> - <param name="owningObject">To be added.</param> - <param name="member">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method can be invoked multiple times for the same object to build up a list of serialized members within the serialization store. The member generally has to be a property or an event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given member on the given object.</para> + </summary> + <param name="store"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> to which <paramref name="member" /> will be serialized. </param> + <param name="owningObject"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that owns the <paramref name="member" />.</param> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />The given member.</param> </Docs> </Member> <Member MemberName="SerializeMemberAbsolute"> @@ -216,12 +291,21 @@ <Parameter Name="member" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="store">To be added.</param> - <param name="owningObject">To be added.</param> - <param name="member">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For some members, containing the default property value and setting the same value back to the member are different concepts. For example, if a property inherits its value from a parent object if no local value is set, setting the value back to the property may not be what is desired. The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomComponentSerializationService.SerializeMemberAbsolute(System.ComponentModel.Design.Serialization.SerializationStore,System.Object,System.ComponentModel.MemberDescriptor)" /> method takes this into account and would clear the state of the property in this case.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given member on the given object, but also serializes the member if it contains the default property value.</para> + </summary> + <param name="store"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> to which <paramref name="member" /> will be serialized. </param> + <param name="owningObject"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that owns the <paramref name="member" />.</param> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />The given member.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomDesignerLoader.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomDesignerLoader.xml index 4a3c3badd50..d36455b4f6f 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomDesignerLoader.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomDesignerLoader.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CodeDomDesignerLoader" FullName="System.ComponentModel.Design.Serialization.CodeDomDesignerLoader"> <TypeSignature Language="C#" Value="public abstract class CodeDomDesignerLoader : System.ComponentModel.Design.Serialization.BasicDesignerLoader, System.ComponentModel.Design.Serialization.IDesignerSerializationService, System.ComponentModel.Design.Serialization.INameCreationService" /> <AssemblyInfo> @@ -16,8 +17,15 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> is an abstract class that provides a full designer loader based on the Code Document Object Model (CodeDOM). You provide the CodeDOM parser and generator, and a type resolution service.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides the base class for implementing a CodeDOM-based designer loader.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -28,8 +36,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="CodeDomProvider"> @@ -42,9 +53,15 @@ <ReturnType>System.CodeDom.Compiler.CodeDomProvider</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The designer loader does not parse or generate code from the returned <see cref="P:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.CodeDomProvider" />, but it does use the provider to obtain an <see cref="T:System.CodeDom.Compiler.ICodeGenerator" /> that it can use to validate identifiers in the name-creation service. The designer loader will also check the <see cref="P:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.CodeDomProvider" /> to see if it implements the <see cref="T:System.ComponentModel.Design.Serialization.ICodeDomDesignerReload" /> interface. For more information on parsing or generating code, see the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Parse" /> and <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Write(System.CodeDom.CodeCompileUnit)" /> methods.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="P:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.CodeDomProvider" /> this designer loader will use. </para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -58,8 +75,18 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Dispose" /> method removes services added by the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Initialize" /> method.</para> + <para>Call <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Dispose" /> when you are finished using the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" />. The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Dispose" /> method leaves the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> in an unusable state. After calling <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Dispose" />, you must release all references to the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> 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.Serialization.CodeDomDesignerLoader.Dispose" /> before you release your last reference to the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> object's Finalize method.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the resources used by the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Initialize"> @@ -73,8 +100,57 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The following table describes the replaceable services that the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> adds to the service container.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Term</para> + </term> + <description> + <para>Definition</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.INameCreationService" /> + </para> + </term> + <description> + <para>Provides semantics for creating names of objects. The service uses the CodeDOM provider’s <see cref="T:System.CodeDom.Compiler.ICodeGenerator" /> interface to create names that are valid identifiers for the language. In addition, the name creation service supports empty names. Empty names should be interpreted as temporary local variables during serialization.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationService" /> + </para> + </term> + <description> + <para>Allows other objects to serialize a group of components into a binary object. This service is most often used by features such as copy and paste or undo and redo. The <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> class provides a designer serialization service that is based on creating CodeDOM trees for objects.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.ComponentSerializationService" /> + </para> + </term> + <description> + <para>This service replaces <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationService" /> as a means to serialize components to a binary object.</para> + </description> + </item> + </list> + <para>For details on replaceable and non-replaceable services, see <see cref="T:System.ComponentModel.Design.Serialization.BasicDesignerLoader" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes services.</para> + </summary> </Docs> </Member> <Member MemberName="IsReloadNeeded"> @@ -88,9 +164,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.IsReloadNeeded" /> method checks for the presence of the <see cref="T:System.ComponentModel.Design.Serialization.ICodeDomDesignerReload" /> interface on the <see cref="P:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.CodeDomProvider" />. The provider will reparse the CodeDOM tree and pass the resulting parse tree to the <see cref="M:System.ComponentModel.Design.Serialization.ICodeDomDesignerReload.ShouldReloadDesigner(System.CodeDom.CodeCompileUnit)" /> method. If this method returns false, the designer will not be reloaded.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value indicating whether a reload is required.</para> + </summary> </Docs> </Member> <Member MemberName="OnBeginLoad"> @@ -104,8 +186,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For more information on the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.OnBeginLoad" /> method, see <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginLoad" />. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the designer loader that loading is about to begin.</para> + </summary> </Docs> </Member> <Member MemberName="OnBeginUnload"> @@ -119,8 +207,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For more information on the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.OnBeginUnload" /> method, see <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnBeginUnload" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the designer loader that unloading is about to begin.</para> + </summary> </Docs> </Member> <Member MemberName="OnComponentRename"> @@ -138,11 +232,17 @@ <Parameter Name="newName" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="oldName">To be added.</param> - <param name="newName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentRename" /> event. </para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to rename.</param> + <param name="oldName"> + <attribution license="cc4" from="Microsoft" modified="false" />The original name of the component.</param> + <param name="newName"> + <attribution license="cc4" from="Microsoft" modified="false" />The new name of the component.</param> </Docs> </Member> <Member MemberName="OnEndLoad"> @@ -159,10 +259,18 @@ <Parameter Name="errors" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="successful">To be added.</param> - <param name="errors">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For more information on the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" /> method, see <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.OnEndLoad(System.Boolean,System.Collections.ICollection)" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the designer loader that loading is complete.</para> + </summary> + <param name="successful"> + <attribution license="cc4" from="Microsoft" modified="false" />true to indicate that the load completed successfully; otherwise, false.</param> + <param name="errors"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ICollection" /> of objects (usually exceptions) that were reported as errors.</param> </Docs> </Member> <Member MemberName="Parse"> @@ -176,9 +284,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Parse" /> method is called when the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> needs to parse the source code. The source code location and format must be specified by deriving classes.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Parses the text or other persistent storage and returns a <see cref="T:System.CodeDom.CodeCompileUnit" />.</para> + </summary> </Docs> </Member> <Member MemberName="PerformFlush"> @@ -194,9 +308,20 @@ <Parameter Name="manager" Type="System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.PerformFlush(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> method obtains the root <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> for the root component of the designer and invokes the serializer to serialize the component. If the result of this operation is a <see cref="T:System.CodeDom.CodeTypeDeclaration" />, then <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.PerformFlush(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> integrates the <see cref="T:System.CodeDom.CodeTypeDeclaration" /> with the existing CodeDOM tree. The result is the original CodeDOM tree with matching members and statements replaced. Finally, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.PerformFlush(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> calls the abstract <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Write(System.CodeDom.CodeCompileUnit)" /> method to save this CodeDOM tree.</para> + <para>If the serialization of the root designer component does not result in a <see cref="T:System.CodeDom.CodeTypeDeclaration" />, then <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.PerformFlush(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> does nothing further.</para> + <block subset="none" type="note"> + <para>It is the responsibility of the caller to ensure that a CodeDOM originates from a trusted source. Accepting a CodeDOM object from an untrusted party could allow that party to run malicious code. When flushing a CodeDOM into a file, the framework will run code represented by the CodeDOM object and the serialized content of the object as provided.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Requests serialization of the root component of the designer.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> from which to request the serializer.</param> </Docs> </Member> <Member MemberName="PerformLoad"> @@ -212,9 +337,19 @@ <Parameter Name="manager" Type="System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.PerformLoad(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> method obtains an <see cref="T:System.CodeDom.Compiler.ICodeParser" /> from the CodeDOM provider and parses the code. <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.PerformLoad(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> locates the first class in the file, obtains a root <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> for the data type, and then invokes the serializer to deserialize the data type. <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.PerformLoad(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> assumes that this process will create all necessary components in the <see cref="T:System.ComponentModel.IContainer" /> of the <see cref="P:System.ComponentModel.Design.Serialization.BasicDesignerLoader.LoaderHost" /> property. Finally, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.PerformLoad(System.ComponentModel.Design.Serialization.IDesignerSerializationManager)" /> calls the <see cref="M:System.ComponentModel.Design.Serialization.BasicDesignerLoader.SetBaseComponentClassName(System.String)" /> method with the fully qualified name of the type it passed to the CodeDOM serializer.</para> + <block subset="none" type="note"> + <para>It is the responsibility of the caller to ensure that a CodeDOM originates from a trusted source. Accepting a CodeDOM object from an untrusted party could allow that party to run malicious code. When loading a CodeDOM into the design surface, the framework will run code represented by the CodeDOM object and the serialized content of the object as provided.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Parses code from a CodeDOM provider.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> from which to request the serializer.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationService.Deserialize"> @@ -230,10 +365,14 @@ <Parameter Name="serializationData" Type="System.Object" /> </Parameters> <Docs> - <param name="serializationData">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes the specified serialization data object and returns a collection of objects represented by that data.</para> + </summary> + <param name="serializationData"> + <attribution license="cc4" from="Microsoft" modified="false" />An object consisting of serialized data.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationService.Serialize"> @@ -249,10 +388,14 @@ <Parameter Name="objects" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="objects">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the specified collection of objects and stores them in a serialization data object.</para> + </summary> + <param name="objects"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection of objects to serialize.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.INameCreationService.CreateName"> @@ -269,11 +412,16 @@ <Parameter Name="dataType" Type="System.Type" /> </Parameters> <Docs> - <param name="container">To be added.</param> - <param name="dataType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new name that is unique to all components in the specified container.</para> + </summary> + <param name="container"> + <attribution license="cc4" from="Microsoft" modified="false" />The container where the new object is added.</param> + <param name="dataType"> + <attribution license="cc4" from="Microsoft" modified="false" />The data type of the object that receives the name.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.INameCreationService.IsValidName"> @@ -289,10 +437,14 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the specified name is valid.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name to validate.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.INameCreationService.ValidateName"> @@ -308,9 +460,13 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the specified name is valid.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name to validate.</param> </Docs> </Member> <Member MemberName="TypeResolutionService"> @@ -323,9 +479,15 @@ <ReturnType>System.ComponentModel.Design.ITypeResolutionService</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> automatically adds this <see cref="T:System.ComponentModel.Design.ITypeResolutionService" /> to the service container when the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Initialize" /> method is invoked. While the type resolution service is optional in many scenarios, it is required for code interpretation because source code contains type names, but no assembly references.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type resolution service to be used with this designer loader.</para> + </summary> </Docs> </Member> <Member MemberName="Write"> @@ -341,10 +503,17 @@ <Parameter Name="unit" Type="System.CodeDom.CodeCompileUnit" /> </Parameters> <Docs> - <param name="unit">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Write(System.CodeDom.CodeCompileUnit)" /> method saves a <see cref="T:System.CodeDom.CodeCompileUnit" /> to persistent storage. The deriving class is responsible for invoking the <see cref="T:System.CodeDom.Compiler.ICodeGenerator" /> on the appropriate text writer to save the code. The <see cref="T:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader" /> ensures that the CodeDOM objects that are passed to <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Write(System.CodeDom.CodeCompileUnit)" /> are the same instances of objects that were retrieved from <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Parse" />, except in cases where the serialization process had to make changes to the code. This allows an optimized designer loader to store additional data in the <see cref="P:System.CodeDom.CodeObject.UserData" /> property of code elements. This data will be available during the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomDesignerLoader.Write(System.CodeDom.CodeCompileUnit)" /> method for any elements that were not replaced by the serialization process.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Writes compile-unit changes to persistent storage.</para> + </summary> + <param name="unit"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeCompileUnit" /> to be persisted.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomLocalizationModel.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomLocalizationModel.xml index 1fd366b4943..cc8e3e9d7ce 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomLocalizationModel.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomLocalizationModel.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CodeDomLocalizationModel" FullName="System.ComponentModel.Design.Serialization.CodeDomLocalizationModel"> <TypeSignature Language="C#" Value="public enum CodeDomLocalizationModel" /> <AssemblyInfo> @@ -8,8 +9,11 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines the localization model to be used by the CodeDom resource adapter.</para> + </summary> </Docs> <Members> <Member MemberName="None"> @@ -22,7 +26,10 @@ <ReturnType>System.ComponentModel.Design.Serialization.CodeDomLocalizationModel</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The localization provider should ignore localized properties. It will still write out resources for objects that do not support code generation and are serializable.</para> + </summary> </Docs> </Member> <Member MemberName="PropertyAssignment"> @@ -35,7 +42,10 @@ <ReturnType>System.ComponentModel.Design.Serialization.CodeDomLocalizationModel</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The localization provider will write out localized properties by assigning a resource to each property. This model is fast when the number of properties is small, but it scales poorly as the number of properties containing default values grows.</para> + </summary> </Docs> </Member> <Member MemberName="PropertyReflection"> @@ -48,8 +58,11 @@ <ReturnType>System.ComponentModel.Design.Serialization.CodeDomLocalizationModel</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The localization provider will write localized property values into a resource file and use the <see cref="T:System.ComponentModel.ComponentResourceManager" /> class to reflect on properties by name to fill them at runtime. This uses reflection at runtime so it can be slow, but it scales better for large numbers of properties with default values.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomLocalizationProvider.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomLocalizationProvider.xml index 6c135b7ddc1..b7f2e024981 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomLocalizationProvider.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomLocalizationProvider.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CodeDomLocalizationProvider" FullName="System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider"> <TypeSignature Language="C#" Value="public sealed class CodeDomLocalizationProvider : IDisposable, System.ComponentModel.Design.Serialization.IDesignerSerializationProvider" /> <AssemblyInfo> @@ -16,8 +17,15 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider" /> class is a serialization provider that provides a localization feature. It supports serializing to resources through <see cref="T:System.ComponentModel.Design.IResourceService" />, and it adds two properties to the root component: Language and Localizable. If Localizable is set to true, this provider changes the way that component properties are generated and routes their values to a resource file. Two localization models are supported.</para> + <para>You can control the cultures that are offered and the style of localization with constructor parameters.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides CodeDOM resource serialization services. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -31,10 +39,19 @@ <Parameter Name="model" Type="System.ComponentModel.Design.Serialization.CodeDomLocalizationModel" /> </Parameters> <Docs> - <param name="provider">To be added.</param> - <param name="model">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider.#ctor" /> constructor creates a new adapter and attaches it to the serialization manager. This adds itself as a serializer for resources into the serialization manager, and, if not already added, adds itself as an extender provider to the root component. </para> + <para>If the <paramref name="model" /> parameter is not <see cref="F:System.ComponentModel.Design.Serialization.CodeDomLocalizationModel.None" />, the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider" /> provides the Language and Localizable properties.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider" /> class. </para> + </summary> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> used by the localization provider to add its extender properties.</param> + <param name="model"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.Serialization.CodeDomLocalizationModel" /> value indicating the localization model to be used by the CodeDOM resource adapter </param> </Docs> </Member> <Member MemberName=".ctor"> @@ -49,11 +66,22 @@ <Parameter Name="supportedCultures" Type="System.Globalization.CultureInfo[]" /> </Parameters> <Docs> - <param name="provider">To be added.</param> - <param name="model">To be added.</param> - <param name="supportedCultures">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider.#ctor" /> constructor creates a new adapter and attaches it to the serialization manager. This adds itself as a serializer for resources into the serialization manager, and, if not already added, adds itself as an extender provider to the root component.</para> + <para>If the <paramref name="model" /> parameter is not <see cref="F:System.ComponentModel.Design.Serialization.CodeDomLocalizationModel.None" />, the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider" /> provides the Language and Localizable properties.</para> + <para>If <paramref name="supportedCultures" /> is not provided, the default is all cultures that are currently installed on the computer. If an array of cultures is provided, and it includes cultures that are not installed on the computer, those cultures are not available.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider" /> class. </para> + </summary> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> used by the localization provider to add its extender properties.</param> + <param name="model"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.Serialization.CodeDomLocalizationModel" /> value indicating the localization model to be used by the CodeDOM resource adapter </param> + <param name="supportedCultures"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of cultures that this resource adapter should support.</param> </Docs> </Member> <Member MemberName="Dispose"> @@ -67,8 +95,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases all resources used by the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationProvider.GetSerializer"> @@ -87,14 +118,24 @@ <Parameter Name="serializerType" Type="System.Type" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="currentSerializer">To be added.</param> - <param name="objectType">To be added.</param> - <param name="serializerType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomLocalizationProvider" /> instance is cast to an <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationProvider" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationProvider.GetSerializer(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.Type,System.Type)" />.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager requesting the serializer. </param> + <param name="currentSerializer"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the current serializer of the specified type. This can be null if no serializer of the specified type exists. </param> + <param name="objectType"> + <attribution license="cc4" from="Microsoft" modified="false" />The data type of the object to serialize. </param> + <param name="serializerType"> + <attribution license="cc4" from="Microsoft" modified="false" />The data type of the serializer to create. </param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializer.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializer.xml index 72d2373451c..3b3a73c7f81 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializer.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializer.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CodeDomSerializer" FullName="System.ComponentModel.Design.Serialization.CodeDomSerializer"> <TypeSignature Language="C#" Value="public class CodeDomSerializer : System.ComponentModel.Design.Serialization.CodeDomSerializerBase" /> <AssemblyInfo> @@ -9,8 +10,41 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You can implement a custom <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> to control the generation of component initialization code for a type of component at design time.</para> + <para>To implement a custom <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> for a type, you must: </para> + <list type="ordered"> + <item> + <para>Define a class that derives from <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" />.</para> + </item> + <item> + <para>Implement method overrides for serialization or deserialization methods. (See the information below for details.) </para> + </item> + <item> + <para>Associate your custom <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> implementation with a type of component using a <see cref="T:System.ComponentModel.Design.Serialization.DesignerSerializerAttribute" />.</para> + </item> + </list> + <para>To implement a serialization method for generating configuration code for a component: </para> + <list type="ordered"> + <item> + <para>Within a class that derives from <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" />, override an appropriate serialization or deserialization method of the base class.</para> + </item> + <item> + <para>If you want the default serializer to generate code statements that perform the default component configuration, you must obtain and call the base serializer for the component. To obtain the base serializer for the component, call the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetSerializer(System.Type,System.Type)" /> method of the <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> passed to your method override. Pass the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetSerializer(System.Type,System.Type)" /> method the type of the component to serialize the configuration of, along with the base type of serializer you are requesting, which is <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" />. Call the method of the same name you are overriding on the base serializer, using the <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> and object passed to your method override. If you are implementing the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializer.Serialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method, the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializer.Serialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method of the base serializer will return an object. The type of this object depends on the type of base serializer which depends on the type of component you are serializing the values of. If you are implementing the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeEvents(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.Attribute[])" />, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeProperties(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.Attribute[])" />, or <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializePropertiesToResources(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.Attribute[])" /> method, you must create a new <see cref="T:System.CodeDom.CodeStatementCollection" /> to contain the generated code statements, and pass it to the method.</para> + </item> + <item> + <para>If you have called a base serializer method, you will have a <see cref="T:System.CodeDom.CodeStatementCollection" /> that contains the statements to generate to initialize the component. Otherwise you should create a <see cref="T:System.CodeDom.CodeStatementCollection" />. You can add <see cref="T:System.CodeDom.CodeStatement" /> objects representing statements to generate in the component configuration code to this collection.</para> + </item> + <item> + <para>Return the <see cref="T:System.CodeDom.CodeStatementCollection" /> that represents the source code to generate to configure the component.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes an object graph to a series of CodeDOM statements. This class provides an abstract base class for a serializer.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -18,8 +52,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -36,11 +73,19 @@ <Parameter Name="codeObject" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="codeObject">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method uses the serialization manager to create objects and resolve data types. The root of the object graph is returned.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes the specified serialized CodeDOM object into an object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />A serialization manager interface that is used during the deserialization process. </param> + <param name="codeObject"> + <attribution license="cc4" from="Microsoft" modified="false" />A serialized CodeDOM object to deserialize. </param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -60,11 +105,19 @@ <Parameter Name="statement" Type="System.CodeDom.CodeStatement" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="statement">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializer.DeserializeStatementToInstance(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatement)" /> is equivalent of calling <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.DeserializeStatement(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatement)" />, except that it returns an object instance if the resulting statement was a variable assign statement, a variable declaration with an init expression, or a field assignment statement.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes a single statement.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="statement"> + <attribution license="cc4" from="Microsoft" modified="false" />The statement to deserialize.</param> </Docs> </Member> <Member MemberName="GetTargetComponentName"> @@ -82,12 +135,18 @@ <Parameter Name="targetType" Type="System.Type" /> </Parameters> <Docs> - <param name="statement">To be added.</param> - <param name="expression">To be added.</param> - <param name="targetType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines which statement group the given statement should belong to.</para> + </summary> + <param name="statement"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeStatement" /> for which to determine the group.</param> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.CodeDom.CodeExpression" /> that <paramref name="statement" /> has been reduced to.</param> + <param name="targetType"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of <paramref name="statement" />.</param> </Docs> </Member> <Member MemberName="Serialize"> @@ -101,11 +160,16 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the specified object into a CodeDOM object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use during serialization. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize. </param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -125,11 +189,16 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given object, accounting for default values.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> </Docs> </Member> <Member MemberName="SerializeMember"> @@ -147,12 +216,17 @@ <Parameter Name="member" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="owningobject">To be added.</param> - <param name="member">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given member on the given object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />The member to serialize.</param> </Docs> </Member> <Member MemberName="SerializeMemberAbsolute"> @@ -170,12 +244,17 @@ <Parameter Name="member" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="owningobject">To be added.</param> - <param name="member">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given member, accounting for default values.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />The member to serialize.</param> </Docs> </Member> <Member MemberName="SerializeToReferenceExpression"> @@ -189,11 +268,19 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is similar to <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" />, except that it stops if it cannot obtain a simple reference expression for the value. Call this method when you expect the resulting expression to be used as a parameter or target of a statement.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the specified value to a CodeDOM expression.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use during serialization. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize. </param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -205,4 +292,4 @@ </Attributes> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializerBase.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializerBase.xml index fb383d9947f..8fc69fc896b 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializerBase.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializerBase.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CodeDomSerializerBase" FullName="System.ComponentModel.Design.Serialization.CodeDomSerializerBase"> <TypeSignature Language="C#" Value="public abstract class CodeDomSerializerBase" /> <AssemblyInfo> @@ -14,8 +15,14 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializerBase" /> class is used as a shared base between the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> and <see cref="T:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer" /> classes. Public <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> classes derive from the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializerBase" /> class. Each public class defines its own public API. The <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializerBase" /> class defines no public API, but does offer a multitude of utility methods that can be used to aid the serialization process. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base class for <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> classes.</para> + </summary> </Docs> <Members> <Member MemberName="DeserializeExpression"> @@ -33,12 +40,81 @@ <Parameter Name="expression" Type="System.CodeDom.CodeExpression" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="name">To be added.</param> - <param name="expression">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This is a helper method that derived classes can call to deserialize an expression. It deserializes the statement by interpreting and executing the CodeDOM expression specified by the <paramref name="expression" /> parameter, and then returns the results. If an object needs to be created as a result of this expression, it will be given the name specified by the <paramref name="name" /> parameter. The name can be null if there is no need to name the object. The following table describes how specific expressions are handled.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Expression</para> + </term> + <description> + <para>Behavior</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.CodeDom.CodeThisReferenceExpression" /> + </para> + </term> + <description> + <para>This expression represents this or Me. To locate the object that is associated with this expression, the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.DeserializeExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.String,System.CodeDom.CodeExpression)" /> method will look in the context stack for a <see cref="T:System.ComponentModel.Design.Serialization.RootContext" />. This object contains the root object of the graph and the expression that represents it. If the object is present and the expression matches, the root object will be returned. An error is reported if an instance cannot be located.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.CodeDom.CodeFieldReferenceExpression" /> + </para> + </term> + <description> + <para>If the target of the field reference evaluates to the root object, the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetInstance(System.String)" /> method of the manager parameter will be used to retrieve the object instance based on name. Otherwise, standard reflection is used against the target object to locate the requested field. An error is reported if the field cannot be located.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.CodeDom.CodeVariableReferenceExpression" /> + </para> + </term> + <description> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetInstance(System.String)" /> method of the <paramref name="manager" /> parameter is used to locate the instance representing the given variable name. An error is reported if an instance cannot be located.</para> + </description> + </item> + </list> + <para> + <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.DeserializeExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.String,System.CodeDom.CodeExpression)" /> continues to interpret expressions until they are completely resolved to an object, or until it can no longer simplify the expression. In this case, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.DeserializeExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.String,System.CodeDom.CodeExpression)" /> will return a <see cref="T:System.CodeDom.CodeExpression" /> that contains the most simplified expression. The following expressions are not supported:</para> + <list type="bullet"> + <item> + <para> + <see cref="T:System.CodeDom.CodeEventReferenceExpression" /> + </para> + </item> + <item> + <para> + <see cref="T:System.CodeDom.CodeMethodReferenceExpression" /> + </para> + </item> + <item> + <para> + <see cref="T:System.CodeDom.CodeDelegateCreateExpression" /> </para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes the given expression into an in-memory object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the object that results from the expression. Can be null if there is no need to name the object.</param> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeExpression" /> to interpret.</param> </Docs> </Member> <Member MemberName="DeserializeInstance"> @@ -58,14 +134,25 @@ <Parameter Name="addToContainer" Type="System.Boolean" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="type">To be added.</param> - <param name="parameters">To be added.</param> - <param name="name">To be added.</param> - <param name="addToContainer">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.DeserializeInstance(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Type,System.Object[],System.String,System.Boolean)" /> method is invoked during deserialization to obtain an instance of an object. When this is called, an instance of the requested type should be returned. The default implementation invokes the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> method of the <paramref name="manager" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an instance of the given type.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the instance to return.</param> + <param name="parameters"> + <attribution license="cc4" from="Microsoft" modified="false" />The parameters to pass to the constructor for <paramref name="type" />.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the deserialized object.</param> + <param name="addToContainer"> + <attribution license="cc4" from="Microsoft" modified="false" />true to add this object to the design container; otherwise, false. The object must implement <see cref="T:System.ComponentModel.IComponent" /> for this to have any effect.</param> </Docs> </Member> <Member MemberName="DeserializePropertiesFromResources"> @@ -83,11 +170,22 @@ <Parameter Name="filter" Type="System.Attribute[]" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <param name="filter">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.DeserializePropertiesFromResources(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.Attribute[])" /> method is a helper method that derived classes can call. It looks for properties on the given object and attempts to load their values out of the invariant culture’s resource bundle. This is generally used to handle design-time properties that are not emitted into source code. It should not be used for localized properties because it only operates on the invariant culture.</para> + <para>This method inspects all of the properties of the <paramref name="value" /> parameter that match the attributes specified by the <paramref name="filter" /> parameter, and then checks for those properties in a resource binary object. This is useful for deserializing properties that cannot be represented in code, such as design-time properties.</para> + <para>This method requires that a designer loader offers an <see cref="T:System.ComponentModel.Design.IResourceService" /> to read resources. If the <see cref="T:System.ComponentModel.Design.IResourceService" /> provides a <see cref="T:System.Resources.ResXResourceReader" /> for the invariant culture, then <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.DeserializePropertiesFromResources(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.Attribute[])" /> will read resources from the XML resource (.resx) file’s metadata section, which is not included in final compiled code. If this service is not available, no resources will be read.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes properties on the given object from the invariant culture’s resource bundle.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object from which the properties are to be deserialized.</param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Attribute" /> array that filters which properties will be deserialized.</param> </Docs> </Member> <Member MemberName="DeserializeStatement"> @@ -104,10 +202,19 @@ <Parameter Name="statement" Type="System.CodeDom.CodeStatement" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="statement">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.DeserializeStatement(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatement)" /> method is a helper method that derived classes can call. It interprets the <paramref name="statement" /> parameter.</para> + <para>The <see cref="T:System.CodeDom.CodeStatement" /> being deserialized will be pushed on the context stack.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes a statement by interpreting and executing a CodeDOM statement.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="statement"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeStatement" /> to deserialize.</param> </Docs> </Member> <Member MemberName="GetExpression"> @@ -124,11 +231,31 @@ <Parameter Name="instance" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="instance">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method returns an expression representing the given object. It can return null, indicating that no expression has been set that describes the object. Expressions are acquired in one of three ways:</para> + <list type="bullet"> + <item> + <para>The expression could be the result of a prior call to the <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SetExpression" /> method.</para> + </item> + <item> + <para>The expression could have been found in the <see cref="T:System.ComponentModel.Design.Serialization.RootContext" />.</para> + </item> + <item> + <para>The expression could be derived through <see cref="T:System.ComponentModel.Design.IReferenceService" />.</para> + </item> + </list> + <para>To derive expressions through <see cref="T:System.ComponentModel.Design.IReferenceService" />, the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method queries the reference service for a name for the given object. If the expression service returns a valid name, <see cref="T:System.ComponentModel.Design.IReferenceService" />, the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method checks to see if there is a "." in the name. This indicates that the expression service found this object as the return value of a read-only property on another object. If there is a ".", <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> will split the reference into parts. The leftmost part is a name that will be evaluated with the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetInstance(System.String)" /> method. For each subsequent part, a property reference expression will be built. The final expression will then be returned.</para> + <para>If the object did not have an expression set, or if the object was not found in the reference service, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> will return null, indicating there is no existing expression for the object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an expression for the given object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> </Docs> </Member> <Member MemberName="GetSerializer"> @@ -145,11 +272,18 @@ <Parameter Name="instance" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="instance">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetSerializer(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method is an extension to the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetSerializer(System.Type,System.Type)" /> method. The <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetSerializer(System.Type,System.Type)" /> method takes an object type, rather than an object value. If an external party had overridden metadata for a specific object through <see cref="T:System.ComponentModel.TypeDescriptor" />, that metadata override would not be seen by the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetSerializer(System.Type,System.Type)" /> method, which only takes a type. The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetSerializer(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method checks the metadata of the value and the value’s type. If the two differ, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetSerializer(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> will look to see if there is a custom designer serializer attribute on the value. If so, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetSerializer(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> will attempt to use it. Otherwise, it will defer to <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetSerializer(System.Type,System.Type)" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Locates a serializer for the given object value.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> </Docs> </Member> <Member MemberName="GetSerializer"> @@ -166,11 +300,18 @@ <Parameter Name="instanceType" Type="System.Type" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="instanceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetSerializer(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Type)" /> method is an extension to the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetSerializer(System.Type,System.Type)" /> method. The <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetSerializer(System.Type,System.Type)" /> method takes an object type, rather than an object value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Locates a serializer for the given type.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> </Docs> </Member> <Member MemberName="GetUniqueName"> @@ -187,11 +328,18 @@ <Parameter Name="instance" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="instance">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetUniqueName(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method calls the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetName(System.Object)" /> method. If this method does not return a name, then <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetUniqueName(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> uses <see cref="T:System.ComponentModel.Design.Serialization.INameCreationService" /> to fabricate a valid name for the object. If the service is not available, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetUniqueName(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> will fabricate a name based on the short type name combined with an index number to make it unique. The resulting name is associated with the serialization manager by calling the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.SetName(System.Object,System.String)" /> method before the new name is returned.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a unique name for the given object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> </Docs> </Member> <Member MemberName="IsSerialized"> @@ -208,11 +356,19 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For the <paramref name="value" /> parameter to be considered serialized, the <paramref name="manager" /> parameter or another serializer must have called the <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SetExpression" /> method to create a relationship between <paramref name="value" /> and a referring expression.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value indicating whether the given object has been serialized.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to test for previous serialization.</param> </Docs> </Member> <Member MemberName="IsSerialized"> @@ -230,12 +386,20 @@ <Parameter Name="honorPreset" Type="System.Boolean" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="instance">To be added.</param> - <param name="honorPreset">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For the <paramref name="value" /> parameter to be considered serialized, the <paramref name="manager" /> parameter or another serializer must have called the <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SetExpression" /> method to create a relationship between <paramref name="value" /> and a referring expression.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value indicating whether the given object has been serialized, optionally considering preset expressions.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="honorPreset"> + <attribution license="cc4" from="Microsoft" modified="false" />true to include preset expressions; otherwise, false. </param> </Docs> </Member> <Member MemberName="SerializeCreationExpression"> @@ -277,12 +441,26 @@ <Parameter Name="descriptor" Type="System.ComponentModel.EventDescriptor" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="statements">To be added.</param> - <param name="value">To be added.</param> - <param name="descriptor">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeEvent(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.ComponentModel.EventDescriptor)" /> method is a helper method that derived classes can call to serialize a single event into the given <see cref="T:System.CodeDom.CodeStatementCollection" />. <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeEvent(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.ComponentModel.EventDescriptor)" /> queries the serialization manager for a <see cref="T:System.ComponentModel.Design.Serialization.MemberCodeDomSerializer" /> for the given event, and then asks the <see cref="T:System.ComponentModel.Design.Serialization.MemberCodeDomSerializer" /> to serialize it.</para> + <para> + <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeEvent(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.ComponentModel.EventDescriptor)" /> places the <paramref name="statements" /> and <paramref name="descriptor" /> parameters on the <see cref="T:System.ComponentModel.Design.Serialization.ContextStack" />.</para> + <para> + <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeEvent(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.ComponentModel.EventDescriptor)" /> requires an <see cref="T:System.ComponentModel.Design.IEventBindingService" /> to discover event bindings to methods that are not compiled. If this service is not present, event bindings to non-compiled methods will not be written. Event bindings to compiled methods will still be serialized if the objects to which the events are bound can be converted into expressions.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given event into the given statement collection.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="statements"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeStatementCollection" /> into which the event will be serialized.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to which <paramref name="descriptor" /> is bound.</param> + <param name="descriptor"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.EventDescriptor" /> specifying the event to serialize.</param> </Docs> </Member> <Member MemberName="SerializeEvents"> @@ -307,12 +485,23 @@ </Parameter> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="statements">To be added.</param> - <param name="value">To be added.</param> - <param name="filter">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeEvents(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.Attribute[])" /> method is a helper method that derived classes can call. It looks at events on the <paramref name="value" /> parameter that match the <paramref name="filter" /> parameter, and then it calls the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeEvent(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.ComponentModel.EventDescriptor)" /> method for each event.</para> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeEvents(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.Attribute[])" /> method places the <see cref="T:System.ComponentModel.InheritanceAttribute" /> for <paramref name="value" /> on the <see cref="T:System.ComponentModel.Design.Serialization.ContextStack" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the specified events into the given statement collection.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="statements"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeStatementCollection" /> into which the event will be serialized.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object on which events will be serialized.</param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Attribute" /> array that filters which events will be serialized.</param> </Docs> </Member> <Member MemberName="SerializeProperties"> @@ -331,12 +520,23 @@ <Parameter Name="filter" Type="System.Attribute[]" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="statements">To be added.</param> - <param name="value">To be added.</param> - <param name="filter">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeProperties(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.Attribute[])" /> method is a helper method that derived classes can call. It looks at properties on the <paramref name="value" /> parameter that match the <paramref name="filter" /> parameter, and then it calls the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeProperty(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.ComponentModel.PropertyDescriptor)" /> method for each property.</para> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeProperties(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.Attribute[])" /> method places the <see cref="T:System.ComponentModel.InheritanceAttribute" /> for <paramref name="value" /> on the <see cref="T:System.ComponentModel.Design.Serialization.ContextStack" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the properties on the given object into the given statement collection.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="statements"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeStatementCollection" /> into which the properties will be serialized.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object on which the properties will be serialized.</param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Attribute" /> array that filters which properties will be serialized.</param> </Docs> </Member> <Member MemberName="SerializePropertiesToResources"> @@ -355,12 +555,25 @@ <Parameter Name="filter" Type="System.Attribute[]" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="statements">To be added.</param> - <param name="value">To be added.</param> - <param name="filter">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializePropertiesToResources(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.Attribute[])" /> method is a helper method that derived classes can call. It looks at properties on the <paramref name="value" /> parameter that match the <paramref name="filter" /> parameter, and then it serializes the properties into the invariant culture resource bundle. If the resource service returns a <see cref="T:System.Resources.ResXResourceWriter" />, the property values will be stored in the metadata section of the XML resource (.resx) file. The <paramref name="statements" /> parameter is not used. </para> + <para>To be serialized as a resource, a property must be simple (not a content property) and its value must be serializable. Properties that do not conform to this pattern will be skipped.</para> + <para> + <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializePropertiesToResources(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.Attribute[])" /> requires an <see cref="T:System.ComponentModel.Design.IResourceService" /> to obtain a <see cref="T:System.Resources.ResourceWriter" /> to write resources for the invariant culture. If this service is not available, no resources will be written.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the properties on the given object into the invariant culture’s resource bundle.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="statements"> + <attribution license="cc4" from="Microsoft" modified="false" />Not used.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object whose properties will be serialized.</param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Attribute" /> array that filters which properties will be serialized.</param> </Docs> </Member> <Member MemberName="SerializeProperty"> @@ -379,12 +592,24 @@ <Parameter Name="propertyToSerialize" Type="System.ComponentModel.PropertyDescriptor" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="statements">To be added.</param> - <param name="value">To be added.</param> - <param name="propertyToSerialize">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeProperty(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.ComponentModel.PropertyDescriptor)" /> method retrieves a <see cref="T:System.ComponentModel.Design.Serialization.MemberCodeDomSerializer" /> for the <paramref name="propertyToSerialize" /> parameter and delegates to it.</para> + <para> + <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeProperty(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeStatementCollection,System.Object,System.ComponentModel.PropertyDescriptor)" /> places the <paramref name="statements" /> and <paramref name="propertyToSerialize" /> parameters on the <see cref="T:System.ComponentModel.Design.Serialization.ContextStack" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes a property on the given object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="statements"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeStatementCollection" /> into which the property will be serialized.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object on which the property will be serialized.</param> + <param name="propertyToSerialize"> + <attribution license="cc4" from="Microsoft" modified="false" />The property to serialize.</param> </Docs> </Member> <Member MemberName="SerializeResource"> @@ -402,11 +627,22 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="resourceName">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeResource(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.String,System.Object)" /> method is a helper method that serializes a value to a resource bundle under the given name. The culture that the resource is written to is determined by searching the serialization manager’s <see cref="P:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.Properties" /> collection for a property called ResourceCulture. If this property exists, resources will be written to that culture. Otherwise, resources will be written to the invariant culture. The <paramref name="value" /> parameter must be serializable.</para> + <para> + <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeResource(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.String,System.Object)" /> requires an <see cref="T:System.ComponentModel.Design.IResourceService" /> to obtain a <see cref="T:System.Resources.ResourceWriter" /> to write resources for the correct culture. If this service is not available, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeResource(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.String,System.Object)" /> will instead build a binary object in code that represents the resource. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given object into a resource bundle using the given resource name.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="resourceName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the resource bundle into which <paramref name="value" /> will be serialized.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> </Docs> </Member> <Member MemberName="SerializeResourceInvariant"> @@ -424,11 +660,21 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="resourceName">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The resource is always written to the invariant culture. The <paramref name="value" /> parameter must be serializable.</para> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeResourceInvariant(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.String,System.Object)" /> method requires an <see cref="T:System.ComponentModel.Design.IResourceService" /> to obtain a <see cref="T:System.Resources.ResourceWriter" /> to write resources for the correct culture. If this service is not available, <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeResource(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.String,System.Object)" /> will instead build a binary object in code that represents the resource.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given object into a resource bundle using the given resource name.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="resourceName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the resource bundle into which <paramref name="value" /> will be serialized.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> </Docs> </Member> <Member MemberName="SerializeToExpression"> @@ -445,11 +691,41 @@ <Parameter Name="instance" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="instance">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <paramref name="value" /> parameter can be null, in which case a primitive expression will be returned.</para> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method uses the following rules for serializing types:</para> + <list type="ordered"> + <item> + <para>It first calls the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method to see if an expression has already been created for the object. If so, it returns the existing expression.</para> + </item> + <item> + <para>It then locates the object’s serializer, and asks it to serialize.</para> + </item> + <item> + <para>If the return value of the object’s serializer is a <see cref="T:System.CodeDom.CodeExpression" />, the expression is returned.</para> + </item> + <item> + <para>It makes one last call to <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> to see if the serializer added an expression.</para> + </item> + <item> + <para>Finally, it returns null.</para> + </item> + </list> + <para>If no expression could be created and no suitable serializer could be found, an error will be reported through the serialization manager. No error will be reported if a serializer was found but it failed to produce an expression. In this case, it is assumed that the serializer either already reported the error or it did not attempt to serialize the object.</para> + <para>If the serializer returned a statement or a collection of statements, those statements will not be discarded. The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method will first look for a <see cref="T:System.ComponentModel.Design.Serialization.StatementContext" /> on the context stack and add statements to the statement context object's <see cref="P:System.ComponentModel.Design.Serialization.StatementContext.StatementCollection" /> property. If there is no statement context, the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method will look in the context for a <see cref="T:System.CodeDom.CodeStatementCollection" /> and add the statements there. If no place can be found to add the statements, an error will be generated.</para> + <block subset="none" type="note"> + <para>You should not call the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method within <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationService.Serialize(System.Collections.ICollection)" /> when serializing your own object. Instead, you should call <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" />. If it returns null, create your own expression and call <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SetExpression" />. Then proceed with the rest of your serialization.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given object into an expression.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> </Docs> </Member> <Member MemberName="SerializeToResourceExpression"> @@ -466,11 +742,34 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToResourceExpression" /> method is a helper method that serializes a value to a resource expression. This is in contrast to the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeResource(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.String,System.Object)" /> method, which writes a value to a resource binary object. <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToResourceExpression" /> goes one step further and returns an expression that can be used to recover the resource. For example, the return value might be "rm.GetValue("SomeBitmap");". The name of the resource is calculated from the <see cref="T:System.ComponentModel.Design.Serialization.ExpressionContext" />, if one can be found on the context stack. </para> + <para>The <see cref="Overload:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToResourceExpression" /> method will look on the <see cref="T:System.ComponentModel.Design.Serialization.ContextStack" /> for the following objects: </para> + <list type="bullet"> + <item> + <para> + <see cref="T:System.CodeDom.CodeStatementCollection" />—a collection of statements to add a resource manager to, if one needs to be declared.</para> + </item> + <item> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.RootContext" />—the root expression, which is needed to create a resource manager.</para> + </item> + <item> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.ExpressionContext" />—used to fabricate a name for the resource and to decide what type of resource manager call to make.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given object into an expression.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> </Docs> </Member> <Member MemberName="SerializeToResourceExpression"> @@ -488,12 +787,21 @@ <Parameter Name="ensureInvariant" Type="System.Boolean" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <param name="ensureInvariant">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <paramref name="ensureInvariant" /> parameter is true, the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToResourceExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.Boolean)" /> method will also write the resource value into the invariant culture’s resource file if the current ResourceCulture is not the invariant culture..</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given object into an expression appropriate for the invariant culture.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> + <param name="ensureInvariant"> + <attribution license="cc4" from="Microsoft" modified="false" />true to serialize into the invariant culture; otherwise, false.</param> </Docs> </Member> <Member MemberName="SetExpression"> @@ -511,11 +819,19 @@ <Parameter Name="expression" Type="System.CodeDom.CodeExpression" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="instance">To be added.</param> - <param name="expression">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.CodeDom.CodeExpression)" /> method is a helper method that associates a <see cref="T:System.CodeDom.CodeExpression" /> with an object. Objects that have been associated with expressions in this way are accessible through the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method. <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.CodeDom.CodeExpression)" /> stores its expression table as an appended object on the context stack so it is accessible by any serializer’s <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Associates an object with an expression.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeExpression" /> with which to associate <paramref name="value" />.</param> </Docs> </Member> <Member MemberName="SetExpression"> @@ -534,13 +850,22 @@ <Parameter Name="isPreset" Type="System.Boolean" /> </Parameters> <Docs> - <param name="manager">To be added.</param> <param name="instance">To be added.</param> - <param name="expression">To be added.</param> - <param name="isPreset">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.CodeDom.CodeExpression,System.Boolean)" /> method is a helper method that associates a <see cref="T:System.CodeDom.CodeExpression" /> with an object. Objects that have been associated with expressions in this way are accessible through the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method. The <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.CodeDom.CodeExpression,System.Boolean)" /> stores its expression table as an appended object on the context stack so it is accessible by any serializer’s <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.GetExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Associates an object with an expression, optionally specifying a preset expression.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use for serialization.</param> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeExpression" /> with which to associate <paramref name="value" />.</param> + <param name="isPreset"> + <attribution license="cc4" from="Microsoft" modified="false" />true to specify a preset expression; otherwise, false.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializerException.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializerException.xml index 99b2d09991d..375b6b7e0e1 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializerException.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CodeDomSerializerException.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CodeDomSerializerException" FullName="System.ComponentModel.Design.Serialization.CodeDomSerializerException"> <TypeSignature Language="C#" Value="public class CodeDomSerializerException : SystemException" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This exception is thrown when the serializer encounters an error. This exception allows the serializer to return information about the location and type of the error.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The exception that is thrown when line number information is available for a serialization error.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -22,10 +29,15 @@ <Parameter Name="linePragma" Type="System.CodeDom.CodeLinePragma" /> </Parameters> <Docs> - <param name="ex">To be added.</param> - <param name="linePragma">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializerException" /> class using the specified exception and line information.</para> + </summary> + <param name="ex"> + <attribution license="cc4" from="Microsoft" modified="false" />The exception to throw. </param> + <param name="linePragma"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.CodeDom.CodeLinePragma" /> that indicates where the exception occurred. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -43,10 +55,15 @@ <Parameter Name="manager" Type="System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> </Parameters> <Docs> - <param name="ex">To be added.</param> - <param name="manager">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializerException" /> class. </para> + </summary> + <param name="ex"> + <attribution license="cc4" from="Microsoft" modified="false" />The exception to throw. </param> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> object from which to extract the context.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -57,10 +74,15 @@ <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializerException" /> class using the specified serialization data and context.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />Stores the data that was being used to serialize or deserialize the object that the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> was serializing or deserializing. </param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />Describes the source and destination of the stream that generated the exception, as well as a means for serialization to retain that context and an additional caller-defined context. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -75,10 +97,15 @@ <Parameter Name="linePragma" Type="System.CodeDom.CodeLinePragma" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="linePragma">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializerException" /> class using the specified message and line information.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />A message describing the exception. </param> + <param name="linePragma"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.CodeDom.CodeLinePragma" /> that indicates where the exception occurred. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -96,10 +123,15 @@ <Parameter Name="manager" Type="System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="manager">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializerException" /> class. </para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />A message describing the exception. </param> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> object from which to extract the context.</param> </Docs> </Member> <Member MemberName="GetObjectData"> @@ -113,10 +145,15 @@ <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object with the parameter name and additional exception information.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />Stores the data that was being used to serialize or deserialize the object that the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> was serializing or deserializing. </param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />Describes the source and destination of the stream that generated the exception, as well as a means for serialization to retain that context and an additional caller-defined context. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -130,9 +167,12 @@ <ReturnType>System.CodeDom.CodeLinePragma</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the line information for the error associated with this exception.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -140,4 +180,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CollectionCodeDomSerializer.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CollectionCodeDomSerializer.xml index e3448a741f9..52bd86c5baa 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CollectionCodeDomSerializer.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/CollectionCodeDomSerializer.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CollectionCodeDomSerializer" FullName="System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer"> <TypeSignature Language="C#" Value="public class CollectionCodeDomSerializer : System.ComponentModel.Design.Serialization.CodeDomSerializer" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer" /> class can create either statements or expressions. If the object to serialize is an array, the <see cref="T:System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer" /> will create an expression and assign it to the statement in the current context stack. If the object is a collection with an AddRange or similar method, the <see cref="T:System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer" /> will create a statement that calls the method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes collections.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +28,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="MethodSupportsSerialization"> @@ -38,10 +48,17 @@ <Parameter Name="method" Type="System.Reflection.MethodInfo" /> </Parameters> <Docs> - <param name="method">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Checks the <paramref name="method" /> attributes to see if they support serialization.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Verifies serialization support by the <paramref name="method" />.</para> + </summary> + <param name="method"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Reflection.MethodInfo" /> to check for serialization attributes.</param> </Docs> </Member> <Member MemberName="Serialize"> @@ -58,11 +75,40 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Collections are serialized as follows:</para> + <list type="ordered"> + <item> + <para>If the collection is an array, the array is written.</para> + <list type="ordered"> + <item> + <para>If the collection has an AddRange method, it will be called and provided with an array.</para> + </item> + <item> + <para>If the collection has an Add method, it will be called repeatedly until all items in the collection are written.</para> + </item> + </list> + </item> + <item> + <para>If the collection is an <see cref="T:System.Collections.IList" />, the <see cref="M:System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer.Serialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method will cast the collection to an <see cref="T:System.Collections.IList" /> and add through that interface.</para> + <list type="ordered"> + <item> + <para>If the collection has no Add method, but is marked with <see cref="F:System.ComponentModel.DesignerSerializationVisibility.Content" />, <see cref="M:System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer.Serialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> will enumerate the collection and serialize each element.</para> + </item> + </list> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given collection into a CodeDOM object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use during serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> </Docs> </Member> <Member MemberName="SerializeCollection"> @@ -82,15 +128,26 @@ <Parameter Name="valuesToSerialize" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="targetExpression">To be added.</param> - <param name="targetType">To be added.</param> - <param name="originalCollection">To be added.</param> - <param name="valuesToSerialize">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.CodeDom.CodeExpression" /> that refers to the collection can be null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given collection.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> to use during serialization.</param> + <param name="targetExpression"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeExpression" /> that refers to the collection</param> + <param name="targetType"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the collection.</param> + <param name="originalCollection"> + <attribution license="cc4" from="Microsoft" modified="false" />The collection to serialize.</param> + <param name="valuesToSerialize"> + <attribution license="cc4" from="Microsoft" modified="false" />The values to serialize.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/DesignerSerializationManager.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/DesignerSerializationManager.xml index 0ecd6a01425..2606f225b7b 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/DesignerSerializationManager.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/DesignerSerializationManager.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerSerializationManager" FullName="System.ComponentModel.Design.Serialization.DesignerSerializationManager"> <TypeSignature Language="C#" Value="public class DesignerSerializationManager : System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> <AssemblyInfo> @@ -13,8 +14,143 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> interface is designed to be a format-independent interface to an object that controls serialization. It essentially provides context and services to serializers, which actually perform the deserialization. <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> assists in the deserialization process by keeping track of objects. This is similar in technique to the <see cref="T:System.ComponentModel.Design.IDesignerHost" /> interface: designers actually provide the user interface (UI), and <see cref="T:System.ComponentModel.Design.IDesignerHost" /> provides the glue that allows different designers to work together.</para> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.DesignerSerializationManager" /> class implements <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" />. It is designed to provide a generic form of deserialization that is similar to run-time serializers like the <see cref="T:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter" />.</para> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.DesignerSerializationManager" /> class achieves three goals:</para> + <list type="bullet"> + <item> + <para>It is a simple, turnkey object that can be used to deserialize a variety of formats.</para> + </item> + <item> + <para>It is generic and not tied to any particular format. It can be used equally for CodeDOM deserialization as well as markup deserialization.</para> + </item> + <item> + <para>It is extensible and supports different serialization methods that are used in copy/paste and undo/redo scenarios.</para> + </item> + </list> + <para>Design-time serialization has the following differences from run-time object serialization:</para> + <list type="bullet"> + <item> + <para>The object performing the serialization is generally separate from the run-time object, so that design-time logic can be removed from a component.</para> + </item> + <item> + <para>The serialization scheme assumes the object will be created fully initialized, and then modified through property and method invocations during deserialization.</para> + </item> + <item> + <para>Properties of an object that have values that were never set on the object (the properties contain the default values) are not serialized. Conversely, the deserialization stream may have holes.</para> + </item> + <item> + <para>Emphasis is placed on the quality of the content within the serialization stream, rather than the full serialization of an object. This means that if there is no defined way to serialize an object, that object may be skipped rather than throwing an exception. The serialization engine may provide heuristics here to decide which failures can be ignored and which are unrecoverable.</para> + </item> + <item> + <para>The serialization stream may have more data than is needed for deserialization. Source code serialization, for example, has user code mixed in with the code needed to deserialize an object graph. This user code must be ignored on deserialization and preserved on serialization.</para> + </item> + </list> + <para>Because of these differences, a different serialization model applies to design-time serialization. This model utilizes a separate serializer object for each data type being serialized. Each serializer provides its small contribution to the problem as a whole. These serializers are all coordinated through a common serialization manager. The serialization manager is responsible for maintaining state between these different serializers. As an example, consider the following class: </para> + <para>code reference: System.ComponentModel.Design.Serialization.DesignerSerializationManager.SampleObject#2</para> + <para>An instance of this class would utilize three different serializers: one for SampleObject, one for strings, and another for integers. The serializer for SampleObject is called the root serializer because SampleObject is the root of the serialization graph. More complex object graphs can be created as well. For example, consider what would happen if SampleObject were changed as follows:</para> + <para>code reference: System.ComponentModel.Design.Serialization.DesignerSerializationManager.SampleObject#11</para> + <para>This allows SampleObject to have a child that is another instance of itself. The following code fills in the object graph: </para> + <para>code reference: System.ComponentModel.Design.Serialization.DesignerSerializationManager.SampleObject#12</para> + <para>When root is serialized, there will be four serializers used: one root serializer, one serializer for the child SampleObject, one serializer for int, and one serializer for string. Serializers are cached based on type, so there is no need to create a serializer for each instance of SampleObject.</para> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.DesignerSerializationManager" /> class is based on the idea of a serialization session. A session maintains state that can be accessed by the various serializers. When a session is disposed, this state is destroyed. This helps to ensure that serializers remain largely stateless, and helps to clean up serializers that are have been corrupted. The following tables describe how state is managed in and among sessions.</para> + <format type="text/html"> + <h2>Global State</h2> + </format> + <para>This state is owned by the serialization manager object, but is independent of the current serialization session. </para> + <list type="table"> + <listheader> + <item> + <term> + <para>Object</para> + </term> + <description> + <para>Usage</para> + </description> + </item> + </listheader> + <item> + <term> + <para>Serialization providers</para> + </term> + <description> + <para>Objects can add themselves as custom serialization providers. Because these providers are used to locate serializers, they outlive a serialization session.</para> + </description> + </item> + </list> + <format type="text/html"> + <h2>Session-Owned State</h2> + </format> + <para>This state is owned by a session and is destroyed when a session is destroyed. Consequently, accessing any properties or methods that would manipulate this state will throw an exception if the serialization manager is not in an active session.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Object</para> + </term> + <description> + <para>Usage</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="E:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.ResolveName" /> event</para> + </term> + <description> + <para>The <see cref="E:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.ResolveName" /> event is attached by a serializer to provide additional resolution of names. All handlers are detached from this event when a session terminates.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="E:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.SerializationComplete" /> event</para> + </term> + <description> + <para>The <see cref="E:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.SerializationComplete" /> event is raised just before a session is disposed. Then, all handlers are detached from this event.</para> + </description> + </item> + <item> + <term> + <para>Name table</para> + </term> + <description> + <para>The serialization manager maintains a table that maps between objects and their names. Serializers may give objects names for easy identification. This name table is cleared when the session terminates.</para> + </description> + </item> + <item> + <term> + <para>Serializer cache</para> + </term> + <description> + <para>The serialization manager maintains a cache of serializers it has been asked to supply. This cache is cleared when the session terminates. The public <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.GetSerializer(System.Type,System.Type)" /> method can safely be called at any time, but its value is cached only if it is called from within a session.</para> + </description> + </item> + <item> + <term> + <para>Context stack</para> + </term> + <description> + <para>The serialization manager maintains an object called the context stack, which you can access with the <see cref="P:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.Context" /> property. Serializers can use this stack to store additional information that is available to other serializers. For example, a serializer that is serializing a property value can push the property name on the serialization stack before asking the value to serialize. This stack is cleared when the session is terminated.</para> + </description> + </item> + <item> + <term> + <para>Error list</para> + </term> + <description> + <para>The serialization manager maintains a list of errors that occurred during serialization. This list, which is accessed through the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.Errors" /> property, is cleared when the session is terminated. Accessing the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.Errors" /> property between sessions will result in an exception.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an implementation of the <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationManager" /> interface.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,8 +161,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor sets the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.PreserveNames" /> and <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.ValidateRecycledTypes" /> properties to true.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.DesignerSerializationManager" /> class.</para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -39,9 +181,17 @@ <Parameter Name="provider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="provider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If a serializer requests services that cannot be satisfied by the serialization manager, the default implementation will forward those requests to the <paramref name="provider" /> parameter.</para> + <para>This constructor sets the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.PreserveNames" /> and <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.ValidateRecycledTypes" /> properties to true.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.DesignerSerializationManager" /> class with the given service provider.</para> + </summary> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" />.</param> </Docs> </Member> <Member MemberName="Container"> @@ -54,9 +204,15 @@ <ReturnType>System.ComponentModel.IContainer</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If a container exists, all components that are created by the serialization manager will be added to the container. The default implementation of this property will search the service provider for an <see cref="T:System.ComponentModel.Design.IDesignerHost" /> and use the container provided by the designer host, should one exist. Otherwise, this property will return null and no components will be added to a container.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets to the container for this serialization manager.</para> + </summary> </Docs> </Member> <Member MemberName="CreateInstance"> @@ -75,13 +231,23 @@ <Parameter Name="addToContainer" Type="System.Boolean" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <param name="arguments">To be added.</param> - <param name="name">To be added.</param> - <param name="addToContainer">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by serializers when they attempt to create an instance of a type. The default implementation creates a new instance of the type, or it may return an existing instance depending on the values of the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.PreserveNames" /> and <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.RecycleInstances" /> properties. The <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> method uses reflection to create instances and will perform some generic <see cref="T:System.IConvertible" /> transformations on parameters to find a matching constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of a type.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The type to create an instance of.</param> + <param name="arguments"> + <attribution license="cc4" from="Microsoft" modified="false" />The parameters of the type’s constructor. This can be null or an empty collection to invoke the default constructor.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />A name to give the object. If null, the object will not be given a name, unless the object is added to a container and the container gives the object a name.</param> + <param name="addToContainer"> + <attribution license="cc4" from="Microsoft" modified="false" />true to add the object to the container if the object implements <see cref="T:System.ComponentModel.IComponent" />; otherwise, false.</param> </Docs> </Member> <Member MemberName="CreateSession"> @@ -95,9 +261,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Most data within the serialization manager is transient and only lives for the life of a serialization session. When a session is disposed, serialization is considered to be complete and this transient state is cleared. This allows a single instance of a serialization manager to be used to serialize multiple object trees. Some state, including the service provider and any custom serialization providers that were added to the serialization manager, span sessions.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new serialization session.</para> + </summary> </Docs> </Member> <Member MemberName="Errors"> @@ -110,9 +282,15 @@ <ReturnType>System.Collections.IList</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You can only read the error list while a serialization session is active.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the list of errors that occurred during serialization or deserialization.</para> + </summary> </Docs> </Member> <Member MemberName="GetSerializer"> @@ -130,10 +308,17 @@ </Parameters> <Docs> <param name="componentType">To be added.</param> - <param name="serializerType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You can request the type of serializer you would like. This method returns null if there is no serializer of the requested type for the specified object type.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the serializer for the given object type.</para> + </summary> + <param name="serializerType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of serializer to retrieve.</param> </Docs> </Member> <Member MemberName="GetService"> @@ -150,9 +335,15 @@ </Parameters> <Docs> <param name="service">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.GetService(System.Type)" /> method provides access to the underlying container or service provider that was set in the constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the requested service.</para> + </summary> </Docs> </Member> <Member MemberName="GetType"> @@ -169,9 +360,15 @@ </Parameters> <Docs> <param name="name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.ComponentModel.Design.Serialization.DesignerSerializationManager.GetType" /> method will search the service provider for an <see cref="T:System.ComponentModel.Design.ITypeResolutionService" /> and, if available, it will delegate to that service to resolve the type. If an <see cref="T:System.ComponentModel.Design.ITypeResolutionService" /> is not available, <see cref="Overload:System.ComponentModel.Design.Serialization.DesignerSerializationManager.GetType" /> will call the <see cref="M:System.Object.GetType" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the requested type.</para> + </summary> </Docs> </Member> <Member MemberName="OnResolveName"> @@ -187,9 +384,17 @@ <Parameter Name="e" Type="System.ComponentModel.Design.Serialization.ResolveNameEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.OnResolveName(System.ComponentModel.Design.Serialization.ResolveNameEventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.ResolveName" /> event. </para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.Serialization.ResolveNameEventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="OnSessionCreated"> @@ -205,9 +410,17 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.OnSessionCreated(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.Serialization.DesignerSerializationManager.SessionCreated" /> event. </para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="OnSessionDisposed"> @@ -223,9 +436,17 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.OnSessionDisposed(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.Serialization.DesignerSerializationManager.SessionDisposed" /> event. </para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param> </Docs> </Member> <Member MemberName="PreserveNames"> @@ -238,9 +459,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.PreserveNames" /> property determines the behavior of the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> method. If true, <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> will pass the given component name. If false, <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> will check for the presence of the given name in the container. If the name does not exist in the container, <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> will use the given name. If the name does exist in the container, <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> will pass a null value as the name of a component when adding it to the container, thereby giving it a new name. This second variation is useful for implementing a serializer that always duplicates objects, rather than assuming those objects do not exist. Paste commands often use this type of serializer. </para> + <para>You can only change this property when you are not in a serialization session.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value indicating whether the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> method should check for the presence of the given name in the container.</para> + </summary> </Docs> </Member> <Member MemberName="PropertyProvider"> @@ -253,9 +481,16 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.PropertyProvider" /> property provides a way to give the serialization manager a set of serialization properties that serializers can use to guide their behavior.</para> + <para>This object's public properties will be inspected and wrapped in new property descriptors that have a target object of the serialization manager.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the object that should be used to provide properties to the serialization manager's <see cref="P:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.Properties" /> property.</para> + </summary> </Docs> </Member> <Member MemberName="RecycleInstances"> @@ -268,9 +503,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.RecycleInstances" /> property is false, the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> method will always create a new instance of a type. If <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.RecycleInstances" /> is true, <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> will first search the name table and container for an object of the same name. If such an object exists and is of the same type, <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> will return the existing instance. This second variation is useful for implementing a serializer that applies serialization state to an existing set of objects, rather than always creating a new tree. The <ui>Undo</ui> command often uses this type of serializer. </para> + <para>In the case where the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.RecycleInstances" /> property is true, the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.ValidateRecycledTypes" /> property will further modify the behavior of <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> depending on the types of the two objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a flag indicating whether <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> will always create a new instance of a type. </para> + </summary> </Docs> </Member> <Member MemberName="SessionCreated"> @@ -283,8 +525,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a session is created. </para> + </summary> </Docs> </Member> <Member MemberName="SessionDisposed"> @@ -297,8 +542,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a session is disposed.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.AddSerializationProvider"> @@ -314,9 +562,16 @@ <Parameter Name="provider" Type="System.ComponentModel.Design.Serialization.IDesignerSerializationProvider" /> </Parameters> <Docs> - <param name="provider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.GetSerializer(System.Type,System.Type)" /> method is used to request a serialization provider, the serialization manager queries the custom serialization providers first before looking in the type's metadata for the appropriate serializer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a custom serialization provider to the serialization manager.</para> + </summary> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization provider to add.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.Context"> @@ -329,9 +584,15 @@ <ReturnType>System.ComponentModel.Design.Serialization.ContextStack</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A context stack provides a user-defined storage area, implemented as a stack. This storage area is a useful way to provide communication across serializers, as serialization is a generally hierarchical process.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the context stack for this serialization session. </para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.CreateInstance"> @@ -350,13 +611,20 @@ <Parameter Name="addToContainer" Type="System.Boolean" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <param name="arguments">To be added.</param> - <param name="name">To be added.</param> - <param name="addToContainer">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implements the <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> method.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The data type to create. </param> + <param name="arguments"> + <attribution license="cc4" from="Microsoft" modified="false" />The arguments to pass to the constructor for this type. </param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the object. This name can be used to access the object later through <see cref="M:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetInstance(System.String)" />. If null is passed, the object is still created but cannot be accessed by name. </param> + <param name="addToContainer"> + <attribution license="cc4" from="Microsoft" modified="false" />true to add this object to the design container. The object must implement <see cref="T:System.ComponentModel.IComponent" /> for this to have any effect. </param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetInstance"> @@ -372,10 +640,14 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves an instance of a created object of the specified name.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the object to retrieve.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetName"> @@ -392,9 +664,15 @@ </Parameters> <Docs> <param name="instance">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.System#ComponentModel#Design#Serialization#IDesignerSerializationManager#GetName(System.Object)" /> method cannot find a corresponding name for the <paramref name="value" /> parameter, it raises the <see cref="E:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.ResolveName" /> event before it returns null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves a name for the specified object.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetSerializer"> @@ -412,10 +690,14 @@ </Parameters> <Docs> <param name="type">To be added.</param> - <param name="serializerType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a serializer of the requested type for the specified object type.</para> + </summary> + <param name="serializerType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the serializer to retrieve.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.GetType"> @@ -432,9 +714,12 @@ </Parameters> <Docs> <param name="name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a type of the specified name.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.Properties"> @@ -447,9 +732,12 @@ <ReturnType>System.ComponentModel.PropertyDescriptorCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implements the <see cref="P:System.ComponentModel.Design.Serialization.IDesignerSerializationManager.Properties" /> property. </para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.RemoveSerializationProvider"> @@ -465,9 +753,16 @@ <Parameter Name="provider" Type="System.ComponentModel.Design.Serialization.IDesignerSerializationProvider" /> </Parameters> <Docs> - <param name="provider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.System#ComponentModel#Design#Serialization#IDesignerSerializationManager#RemoveSerializationProvider(System.ComponentModel.Design.Serialization.IDesignerSerializationProvider)" /> method removes a custom serialization provider that was previously added by a call to the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.System#ComponentModel#Design#Serialization#IDesignerSerializationManager#AddSerializationProvider(System.ComponentModel.Design.Serialization.IDesignerSerializationProvider)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes a previously added serialization provider.</para> + </summary> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.Serialization.IDesignerSerializationProvider" /> to remove.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.ReportError"> @@ -484,8 +779,16 @@ </Parameters> <Docs> <param name="error">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializers can be written to handle recoverable errors gracefully by calling the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.System#ComponentModel#Design#Serialization#IDesignerSerializationManager#ReportError(System.Object)" /> method with the error information. The serialization manager may support reporting a list of errors after it completes, or it may throw an exception from this method and abort the serialization process. The serializer should continue after calling this function.</para> + <para> + <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.System#ComponentModel#Design#Serialization#IDesignerSerializationManager#ReportError(System.Object)" /> adds the <paramref name="errorInformation" /> parameter to the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.Errors" /> collection. If <paramref name="errorInformation" /> is null, no action is taken.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Used to report a recoverable error in serialization.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.Serialization.IDesignerSerializationManager.SetName"> @@ -502,10 +805,18 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="instance">To be added.</param> - <param name="name">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.System#ComponentModel#Design#Serialization#IDesignerSerializationManager#SetName(System.Object,System.String)" /> method provides a way to set the name of an existing object. This enables creation of an instance of the object through a call to the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.System#ComponentModel#Design#Serialization#IDesignerSerializationManager#GetInstance(System.String)" /> method, avoiding the overhead of the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the name for the specified object.</para> + </summary> + <param name="instance"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to set the name.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> used as the name of the object.</param> </Docs> </Member> <Member MemberName="System.IServiceProvider.GetService"> @@ -522,9 +833,15 @@ </Parameters> <Docs> <param name="service">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.Serialization.DesignerSerializationManager" /> instance is cast to an <see cref="T:System.IServiceProvider" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.IServiceProvider.GetService(System.Type)" /> method.</para> + </summary> </Docs> </Member> <Member MemberName="ValidateRecycledTypes"> @@ -537,10 +854,66 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.ValidateRecycledTypes" /> property modifies the behavior of the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> method when the <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.RecycleInstances" /> property is true, as detailed in the following table.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>RecycleInstances</para> + </term> + <description> + <para>ValidateRecycledTypes</para> + </description> + <description> + <para>Behavior of CreateInstance</para> + </description> + </item> + </listheader> + <item> + <term> + <para>false</para> + </term> + <description> + <para>true or false</para> + </description> + <description> + <para>Always create a new instance of the specified type</para> + </description> + </item> + <item> + <term> + <para>true</para> + </term> + <description> + <para>false</para> + </description> + <description> + <para>If a matching instance is found it is returned, regardless of its type.</para> + </description> + </item> + <item> + <term> + <para>true</para> + </term> + <description> + <para>true</para> + </description> + <description> + <para>If a matching instance is found, it is returned only if its type is the same as specified in the method call.</para> + </description> + </item> + </list> + <para> + <see cref="P:System.ComponentModel.Design.Serialization.DesignerSerializationManager.ValidateRecycledTypes" /> is useful for morphing one type of object to another if they have similar properties but share no common parent or interface. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a flag indicating whether the <see cref="M:System.ComponentModel.Design.Serialization.DesignerSerializationManager.CreateInstance(System.Type,System.Collections.ICollection,System.String,System.Boolean)" /> method will verify that matching names refer to the same type.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ExpressionContext.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ExpressionContext.xml index 4590eda35be..cd391d56d40 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ExpressionContext.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ExpressionContext.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ExpressionContext" FullName="System.ComponentModel.Design.Serialization.ExpressionContext"> <TypeSignature Language="C#" Value="public sealed class ExpressionContext" /> <AssemblyInfo> @@ -9,8 +10,18 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An <see cref="T:System.ComponentModel.Design.Serialization.ExpressionContext" /> is placed on the context stack and contains the most relevant expression during serialization. The following C# code demonstrates an assignment.</para> + <code>button1.Text = "Hello";</code> + <para>During serialization, several serializers are responsible for creating this single statement. One of those serializers is responsible for creating "Hello". There are times when that serializer may need to know the context in which it is creating its expression. In the previous example, this context is not needed. The following C# code shows a situation in which knowledge of the context is necessary.</para> + <code>button1.Text = rm.GetString("button1_Text");</code> + <para>In this case, the serializer responsible for creating the resource expression needs to be informed of the names of the target objects. The <see cref="T:System.ComponentModel.Design.Serialization.ExpressionContext" /> class can be used for this. As each serializer creates an expression and invokes a serializer to handle a smaller part of the statement as a whole, the serializer pushes an expression context on the context stack. Each expression context has a parent property that locates the next expression context on the stack. This provides a convenient traversal capability.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a means of passing context state among serializers. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,11 +36,17 @@ <Parameter Name="owner" Type="System.Object" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="expressionType">To be added.</param> - <param name="owner">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.ExpressionContext" /> class with the given expression and owner. </para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />The given code expression.</param> + <param name="expressionType"> + <attribution license="cc4" from="Microsoft" modified="false" />The given code expression type.</param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The given code expression owner.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -45,12 +62,19 @@ <Parameter Name="presetValue" Type="System.Object" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="expressionType">To be added.</param> - <param name="owner">To be added.</param> - <param name="presetValue">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.ExpressionContext" /> class with a current value.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />The given code expression.</param> + <param name="expressionType"> + <attribution license="cc4" from="Microsoft" modified="false" />The given code expression type.</param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The given code expression owner.</param> + <param name="presetValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The given code expression preset value.</param> </Docs> </Member> <Member MemberName="Expression"> @@ -63,9 +87,12 @@ <ReturnType>System.CodeDom.CodeExpression</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the expression this context represents.</para> + </summary> </Docs> </Member> <Member MemberName="ExpressionType"> @@ -78,9 +105,15 @@ <ReturnType>System.Type</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You can use <see cref="T:System.ComponentModel.Design.Serialization.ExpressionContext" /> to determine if a cast is needed when assigning to the expression.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Type" /> of the expression.</para> + </summary> </Docs> </Member> <Member MemberName="Owner"> @@ -93,9 +126,15 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the expression is a property reference to the <see cref="P:System.Windows.Forms.Control.Text" /> property of an instance of <see cref="T:System.Windows.Forms.Button" /> called button1, <see cref="P:System.ComponentModel.Design.Serialization.ExpressionContext.Owner" /> returns button1.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the object owning this expression.</para> + </summary> </Docs> </Member> <Member MemberName="PresetValue"> @@ -108,10 +147,24 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Contains the preset value of an expression, should one exist. For example, if the expression is a property reference expression referring to the <see cref="P:System.Windows.Forms.Control.Controls" /> property of a <see cref="T:System.Windows.Forms.Button" />, the <see cref="P:System.ComponentModel.Design.Serialization.ExpressionContext.PresetValue" /> property contains the instance of the <see cref="P:System.Windows.Forms.Control.Controls" /> property. This is because the property is read-only and preset by the object to contain a value. On the other hand, a property such as <see cref="P:System.Windows.Forms.Control.Text" /> or <see cref="P:System.Windows.Forms.Control.Visible" /> does not have a preset value and therefore the <see cref="P:System.ComponentModel.Design.Serialization.ExpressionContext.PresetValue" /> property returns null.</para> + <para>The following C# code shows how serializers can use this information to guide serialization.</para> + <para>[C#]</para> + <code>Padding p = new Padding(); +p.Left = 5; +button1.Padding = p; + +button1.Padding.Left = 5;</code> + <para>The serializer of the <see cref="T:System.Windows.Forms.Padding" /> structure needs to be informed if it should generate the first or second form. The first form is generated by default. The second form is only generated if there is an <see cref="T:System.ComponentModel.Design.Serialization.ExpressionContext" /> on the context stack that contains a <see cref="P:System.ComponentModel.Design.Serialization.ExpressionContext.PresetValue" /> equal to the value of the <see cref="T:System.Windows.Forms.Padding" /> currently being serialized.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the preset value of an expression.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ICodeDomDesignerReload.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ICodeDomDesignerReload.xml index 3024be9451d..817e29472a8 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ICodeDomDesignerReload.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ICodeDomDesignerReload.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ICodeDomDesignerReload" FullName="System.ComponentModel.Design.Serialization.ICodeDomDesignerReload"> <TypeSignature Language="C#" Value="public interface ICodeDomDesignerReload" /> <AssemblyInfo> @@ -7,8 +8,15 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> can implement this interface to support optimized reloading by the designer. When a designer reparses a file for display, it can use this interface to improve performance.</para> + <para>To support this performance optimization method, the designer can pass a <see cref="T:System.CodeDom.CodeCompileUnit" /> that represents the document code to the <see cref="M:System.ComponentModel.Design.Serialization.ICodeDomDesignerReload.ShouldReloadDesigner(System.CodeDom.CodeCompileUnit)" /> method. <see cref="M:System.ComponentModel.Design.Serialization.ICodeDomDesignerReload.ShouldReloadDesigner(System.CodeDom.CodeCompileUnit)" /> returns a value that indicates whether the code has changed and typically, whether your code should reload the designer. Otherwise, it is unnecessary to spend time reloading the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface that can be used to optimize the reloading of a designer.</para> + </summary> </Docs> <Members> <Member MemberName="ShouldReloadDesigner"> @@ -21,10 +29,14 @@ <Parameter Name="newTree" Type="System.CodeDom.CodeCompileUnit" /> </Parameters> <Docs> - <param name="newTree">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the designer should reload in order to import the specified compile unit correctly.</para> + </summary> + <param name="newTree"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.CodeDom.CodeCompileUnit" /> containing the designer document code. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -32,4 +44,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/MemberCodeDomSerializer.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/MemberCodeDomSerializer.xml index aa4ab3c952b..1c62359d6bc 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/MemberCodeDomSerializer.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/MemberCodeDomSerializer.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MemberCodeDomSerializer" FullName="System.ComponentModel.Design.Serialization.MemberCodeDomSerializer"> <TypeSignature Language="C#" Value="public abstract class MemberCodeDomSerializer : System.ComponentModel.Design.Serialization.CodeDomSerializerBase" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.MemberCodeDomSerializer" /> class is a "meta" serializer; that is, is a serializer that does not serialize part of the object graph, but instead serializes a reflection primitive within the object graph. For example, a <see cref="T:System.ComponentModel.Design.Serialization.MemberCodeDomSerializer" /> would be associated with a <see cref="T:System.ComponentModel.PropertyDescriptor" /> in order for it to serialize a property. <see cref="T:System.ComponentModel.Design.Serialization.MemberCodeDomSerializer" /> objects enable constructs, such as properties and events, to be logical, rather than requiring them to have a physical backing in code.</para> + <para>Unlike <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> classes, <see cref="T:System.ComponentModel.Design.Serialization.MemberCodeDomSerializer" /> objects must be able to deserialize.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides the base class for serializing a reflection primitive within the object graph.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +29,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.MemberCodeDomSerializer" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="Serialize"> @@ -41,12 +52,22 @@ <Parameter Name="statements" Type="System.CodeDom.CodeStatementCollection" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <param name="descriptor">To be added.</param> - <param name="statements">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method actually performs the serialization. When the member is serialized the necessary statements will be added to the statements collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the given member descriptor on the given value to a statement collection.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to which the member is bound.</param> + <param name="descriptor"> + <attribution license="cc4" from="Microsoft" modified="false" />The descriptor of the member to serialize.</param> + <param name="statements"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeStatementCollection" /> into which <paramref name="descriptor" /> is serialized.</param> </Docs> </Member> <Member MemberName="ShouldSerialize"> @@ -64,13 +85,22 @@ <Parameter Name="descriptor" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <param name="descriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method returns true if the given member descriptor should be serialized, or false if there is no need to serialize the member.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines if the given member should be serialized.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to which the member is bound.</param> + <param name="descriptor"> + <attribution license="cc4" from="Microsoft" modified="false" />The descriptor of the member to serialize.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ObjectStatementCollection.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ObjectStatementCollection.xml index 805cb82ed56..8f1753840dc 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ObjectStatementCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/ObjectStatementCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ObjectStatementCollection" FullName="System.ComponentModel.Design.Serialization.ObjectStatementCollection"> <TypeSignature Language="C#" Value="public sealed class ObjectStatementCollection : System.Collections.IEnumerable" /> <AssemblyInfo> @@ -13,8 +14,11 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Holds a table of statements that is offered by the <see cref="T:System.ComponentModel.Design.Serialization.StatementContext" />. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName="ContainsKey"> @@ -30,10 +34,14 @@ <Parameter Name="statementOwner" Type="System.Object" /> </Parameters> <Docs> - <param name="statementOwner">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the table contains the given statement owner.</para> + </summary> + <param name="statementOwner"> + <attribution license="cc4" from="Microsoft" modified="false" />The owner of the statement collection.</param> </Docs> </Member> <Member MemberName="GetEnumerator"> @@ -47,9 +55,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an <see cref="T:System.Collections.IEnumerator" /> for the <see cref="T:System.ComponentModel.Design.Serialization.ObjectStatementCollection" />.</para> + </summary> </Docs> </Member> <Member MemberName="Item"> @@ -84,9 +95,16 @@ <Parameter Name="statementOwners" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="statementOwners">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If you are the creator of the statement context, you should call the <see cref="M:System.ComponentModel.Design.Serialization.ObjectStatementCollection.Populate(System.Collections.ICollection)" /> method if you want statement tables to be used to store values for certain objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Populates the statement table with a collection of statement owners.</para> + </summary> + <param name="statementOwners"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection of statement owners to add to the table.</param> </Docs> </Member> <Member MemberName="Populate"> @@ -102,9 +120,16 @@ <Parameter Name="owner" Type="System.Object" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If you are the creator of the statement context, you should call the <see cref="M:System.ComponentModel.Design.Serialization.ObjectStatementCollection.Populate(System.Object)" /> method if you want statement tables to be used to store values for certain objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Populates the statement table with a statement owner.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The statement owner to add to the table.</param> </Docs> </Member> <Member MemberName="System.Collections.IEnumerable.GetEnumerator"> @@ -118,10 +143,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.Serialization.ObjectStatementCollection" /> instance is cast to an <see cref="T:System.Collections.IEnumerable" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.Collections.IEnumerable.GetEnumerator" /> method.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/RootContext.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/RootContext.xml index b1e8f96cdba..a4868454647 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/RootContext.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/RootContext.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="RootContext" FullName="System.ComponentModel.Design.Serialization.RootContext"> <TypeSignature Language="C#" Value="public sealed class RootContext" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.RootContext" /> can be placed on the context stack to represent the object that is the root of the serialization hierarchy. In addition to this instance, the <see cref="T:System.ComponentModel.Design.Serialization.RootContext" /> also contains an expression that can be used to reference the <see cref="T:System.ComponentModel.Design.Serialization.RootContext" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> adds a root context to provide a definition of the root object. This class cannot be inherited</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,9 +32,13 @@ </Parameters> <Docs> <param name="expresion">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.RootContext" /> class. </para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The root object of the object graph.</param> </Docs> </Member> <Member MemberName="Expression"> @@ -40,9 +51,12 @@ <ReturnType>System.CodeDom.CodeExpression</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the expression representing the root object in the object graph.</para> + </summary> </Docs> </Member> <Member MemberName="Value"> @@ -55,10 +69,13 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the root object of the object graph.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/SerializeAbsoluteContext.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/SerializeAbsoluteContext.xml index dd03d9011e9..5f4f55e9f7e 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/SerializeAbsoluteContext.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/SerializeAbsoluteContext.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="SerializeAbsoluteContext" FullName="System.ComponentModel.Design.Serialization.SerializeAbsoluteContext"> <TypeSignature Language="C#" Value="public sealed class SerializeAbsoluteContext" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.ComponentSerializationService" /> supports absolute serialization. This means that instead of serializing only values that differ from an object's default values, all values are serialized, allowing values to be reset to their defaults for objects that may have already been initialized. When a component serialization service wishes to indicate this behavior to <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> objects, it will place a <see cref="T:System.ComponentModel.Design.Serialization.SerializeAbsoluteContext" /> object on the context stack. The member in this context may be null, to indicate that all members are serialized, or it can indicate that only a specific member is being serialized at this time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies that serializers should handle default values. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +28,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Using the default constructor indicates that this context should be used for all members.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.SerializeAbsoluteContext" /> class. </para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -35,9 +48,16 @@ <Parameter Name="member" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="member">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If <paramref name="member" /> is null, this context will be used for all members.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.SerializeAbsoluteContext" /> class with the option of binding to a specific member. </para> + </summary> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />The member to which this context is bound. Can be null.</param> </Docs> </Member> <Member MemberName="Member"> @@ -50,9 +70,12 @@ <ReturnType>System.ComponentModel.MemberDescriptor</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the member to which this context is bound.</para> + </summary> </Docs> </Member> <Member MemberName="ShouldSerialize"> @@ -68,11 +91,15 @@ <Parameter Name="member" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="member">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the given member should be serialized in this context.</para> + </summary> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />The member to be examined for serialization.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/StatementContext.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/StatementContext.xml index 00879f86aaf..2c6188f6d76 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/StatementContext.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/StatementContext.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="StatementContext" FullName="System.ComponentModel.Design.Serialization.StatementContext"> <TypeSignature Language="C#" Value="public sealed class StatementContext" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Usually, statements are serialized into the statement collection that is on the context stack. You can modify this behavior by creating a statement context and calling the <see cref="Overload:System.ComponentModel.Design.Serialization.ObjectStatementCollection.Populate" /> method with a collection of objects whose statements you want stored in the statement table. As each object is serialized in the <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method, it has its contents placed in the statement table and saved in the context. If you push this object on the stack, it is your responsibility to integrate the statements added to it into your own collection of statements.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a location into which statements can be serialized. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +28,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.StatementContext" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="StatementCollection"> @@ -35,10 +45,13 @@ <ReturnType>System.ComponentModel.Design.Serialization.ObjectStatementCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of statements offered by the statement context.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/TypeCodeDomSerializer.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/TypeCodeDomSerializer.xml index 17b7d22ecaf..0586a1b4d91 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/TypeCodeDomSerializer.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Serialization/TypeCodeDomSerializer.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TypeCodeDomSerializer" FullName="System.ComponentModel.Design.Serialization.TypeCodeDomSerializer"> <TypeSignature Language="C#" Value="public class TypeCodeDomSerializer : System.ComponentModel.Design.Serialization.CodeDomSerializerBase" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer" /> class performs the same tasks as a <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" />, but serializing an object through this class defines a new type.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes an object to a new type.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +28,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="Deserialize"> @@ -39,11 +49,89 @@ <Parameter Name="declaration" Type="System.CodeDom.CodeTypeDeclaration" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="declaration">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.Deserialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeTypeDeclaration)" /> method deserializes a previously serialized code type declaration. The following table shows the tasks default implementation performs.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Task</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para>Case Sensitivity Checks</para> + </term> + <description> + <para>The implementation searches for a <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> service to decide if it should treat members as case sensitive or case insensitive.</para> + </description> + </item> + <item> + <term> + <para>Statement Sorting</para> + </term> + <description> + <para>All member variables and local variables from init methods are stored in a table. Then each statement in an init method is added to a statement collection grouped according to its left-hand side, so all statements assigning or operating on a particular variable are grouped under that variable. Variables that have no statements are discarded.</para> + </description> + </item> + <item> + <term> + <para>Deserialization</para> + </term> + <description> + <para>The statement collections for each variable are deserialized according to the variable.</para> + </description> + </item> + </list> + <para>The following table shows the services the <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.Deserialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeTypeDeclaration)" /> method requires.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Service</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> + </para> + </term> + <description> + <para>While not strictly necessary, the service, if available, is used to determine if the serialization should be case sensitive or case insensitive.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.IContainer" /> + </para> + </term> + <description> + <para>If an object does not exist in the name table during deserialization, a query for <see cref="T:System.ComponentModel.IContainer" /> is made. If this query succeeds, the container is checked for the object. The container is also used as a stand-in for any container argument needed by components.</para> + </description> + </item> + </list> + <para> </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes the given type declaration.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="declaration"> + <attribution license="cc4" from="Microsoft" modified="false" />Type declaration to use for serialization.</param> </Docs> </Member> <Member MemberName="GetInitializeMethod"> @@ -61,12 +149,21 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="declaration">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.GetInitializeMethod(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeTypeDeclaration,System.Object)" /> method returns the method to emit all of the initialization code for the given member. The default implementation returns an empty constructor. If the same method is to be returned for multiple values, the same instance of the method should be returned. You can use the <see cref="P:System.CodeDom.CodeObject.UserData" /> dictionary to remember methods you have created. The <paramref name="typeDecl" /> parameter can also be used to add infrastructure methods. For example, if you want to emit a separate method for each object, you need a single method that calls all of these methods in turn. This method can be added to the code type declaration as needed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the method where statements used to serialize a member are stored.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="declaration"> + <attribution license="cc4" from="Microsoft" modified="false" />The type declaration to use for serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The value to use for serialization.</param> </Docs> </Member> <Member MemberName="GetInitializeMethods"> @@ -83,11 +180,19 @@ <Parameter Name="declaration" Type="System.CodeDom.CodeTypeDeclaration" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="declaration">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation returns a single-element array with the constructor in it.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an array of methods to be interpreted during deserialization.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="declaration"> + <attribution license="cc4" from="Microsoft" modified="false" />The type declaration to use for serialization.</param> </Docs> </Member> <Member MemberName="Serialize"> @@ -105,13 +210,106 @@ <Parameter Name="members" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="root">To be added.</param> - <param name="members">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.Serialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.Collections.ICollection)" /> method serializes the given root object and optional collection of members to create a new type definition. If the <paramref name="members" /> collection contains values, these values are serialized. Values themselves may serialize as either member variables or local variables. This determination is done by searching for an extender property on the object called GenerateMember. If true, a member is generated. Otherwise, a local variable is generated. For convenience, the <paramref name="members" /> collection can contain the root object. In this case, the root object is not also added as a member or local variable. </para> + <para>The name of the returned type is taken from the root object’s name, if it was a named object. If not, a name is fabricated from the simple type name of the root class. </para> + <para>The following table shows the tasks performed by the default implementation of the <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.Serialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.Collections.ICollection)" /> method.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Task</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para>Context Seeding</para> + </term> + <description> + <para>The serialization context is initialized with data including the <see cref="T:System.ComponentModel.Design.Serialization.RootContext" /> and <see cref="T:System.CodeDom.CodeTypeDeclaration" /></para> + </description> + </item> + <item> + <term> + <para>Member Serialization</para> + </term> + <description> + <para>Next, <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.Serialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.Collections.ICollection)" /> walks all of the members and calls <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" />. Because serialization is done opportunistically in <see cref="M:System.ComponentModel.Design.Serialization.CodeDomSerializerBase.SerializeToExpression(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" />, this ensures that serialization is not done twice.</para> + </description> + </item> + <item> + <term> + <para>Root Serialization</para> + </term> + <description> + <para>Next, the root object is serialized and its statements are added to the statement collection.</para> + </description> + </item> + <item> + <term> + <para>Statement Integration</para> + </term> + <description> + <para>After all objects are serialized, the <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.Serialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.Collections.ICollection)" /> method orders the statements and adds them to a method returned from <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.GetInitializeMethod(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeTypeDeclaration,System.Object)" />. Finally, a constructor is fabricated that calls all of the methods returned from <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.GetInitializeMethod(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.CodeDom.CodeTypeDeclaration,System.Object)" />.</para> + </description> + </item> + </list> + <list type="bullet"> + <item> + <para /> + </item> + </list> + <para>The following table shows the objects the <see cref="M:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer.Serialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object,System.Collections.ICollection)" /> method places on the context stack.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Instance</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.TypeCodeDomSerializer" /> + </para> + </term> + <description> + <para>This serializer. Deriving classes may find it useful to add public properties to this class.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.CodeDom.CodeTypeDeclaration" /> + </para> + </term> + <description> + <para>The type being created. Most objects do not need direct access to this.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the object root by creating a new type declaration that defines root.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use for serialization.</param> + <param name="root"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> + <param name="members"> + <attribution license="cc4" from="Microsoft" modified="false" />Optional collection of members. Can be null or empty.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ActiveDesignSurfaceChangedEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ActiveDesignSurfaceChangedEventArgs.xml index 9c8f9228343..55cf20c9797 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ActiveDesignSurfaceChangedEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ActiveDesignSurfaceChangedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ActiveDesignSurfaceChangedEventArgs" FullName="System.ComponentModel.Design.ActiveDesignSurfaceChangedEventArgs"> <TypeSignature Language="C#" Value="public class ActiveDesignSurfaceChangedEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:System.ComponentModel.Design.DesignSurfaceManager.ActiveDesignSurfaceChanged" /> event.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +28,15 @@ <Parameter Name="newSurface" Type="System.ComponentModel.Design.DesignSurface" /> </Parameters> <Docs> - <param name="oldSurface">To be added.</param> - <param name="newSurface">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.ActiveDesignSurfaceChangedEventArgs" /> class.</para> + </summary> + <param name="oldSurface"> + <attribution license="cc4" from="Microsoft" modified="false" />The design surface that is losing activation.</param> + <param name="newSurface"> + <attribution license="cc4" from="Microsoft" modified="false" />The design surface that is gaining activation.</param> </Docs> </Member> <Member MemberName="NewSurface"> @@ -40,9 +49,12 @@ <ReturnType>System.ComponentModel.Design.DesignSurface</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design surface that is gaining activation.</para> + </summary> </Docs> </Member> <Member MemberName="OldSurface"> @@ -55,10 +67,13 @@ <ReturnType>System.ComponentModel.Design.DesignSurface</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design surface that is losing activation.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ActiveDesignSurfaceChangedEventHandler.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ActiveDesignSurfaceChangedEventHandler.xml index 6772255b233..2491b9c535a 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ActiveDesignSurfaceChangedEventHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ActiveDesignSurfaceChangedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ActiveDesignSurfaceChangedEventHandler" FullName="System.ComponentModel.Design.ActiveDesignSurfaceChangedEventHandler"> <TypeSignature Language="C#" Value="public delegate void ActiveDesignSurfaceChangedEventHandler(object sender, ActiveDesignSurfaceChangedEventArgs e);" /> <AssemblyInfo> @@ -17,7 +18,13 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When you create an <see cref="T:System.ComponentModel.Design.ActiveDesignSurfaceChangedEventHandler" /> delegate, you identify a method to handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:System.ComponentModel.Design.DesignSurfaceManager.ActiveDesignSurfaceChanged" /> event of a <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" />. This class cannot be inherited.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ArrayEditor.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ArrayEditor.xml index eed6367fe50..a1cd237fc6b 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ArrayEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ArrayEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ArrayEditor" FullName="System.ComponentModel.Design.ArrayEditor"> <TypeSignature Language="C#" Value="public class ArrayEditor : System.ComponentModel.Design.CollectionEditor" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This editor can be used to edit arrays within the design-time environment.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for editing arrays at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,9 +28,13 @@ <Parameter Name="type" Type="System.Type" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of <see cref="T:System.ComponentModel.Design.ArrayEditor" /> using the specified data type for the array.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The data type of the items in the array. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,9 +49,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation returns the item type of the array.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data type that this collection is designed to contain.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -57,10 +74,14 @@ <Parameter Name="editValue" Type="System.Object" /> </Parameters> <Docs> - <param name="editValue">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the items in the array.</para> + </summary> + <param name="editValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The array from which to retrieve the items. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -78,11 +99,16 @@ <Parameter Name="value" Type="System.Object[]" /> </Parameters> <Docs> - <param name="editValue">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the items in the array.</para> + </summary> + <param name="editValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The array to set the items to. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The array of objects to set as the items of the array. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -90,4 +116,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/BinaryEditor.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/BinaryEditor.xml index 6be5846de61..d49340f71b8 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/BinaryEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/BinaryEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BinaryEditor" FullName="System.ComponentModel.Design.BinaryEditor"> <TypeSignature Language="C#" Value="public sealed class BinaryEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This editor displays hexadecimal values for binary data and allows you to edit it.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for editing binary data.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.BinaryEditor" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,12 +49,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the specified object using the specified service provider and context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which editing services may be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to edit the value of. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,10 +77,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editor style used by the <see cref="M:System.ComponentModel.Design.BinaryEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -72,4 +92,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ByteViewer.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ByteViewer.xml index 32477c7c279..2e18a1eef17 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ByteViewer.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ByteViewer.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ByteViewer" FullName="System.ComponentModel.Design.ByteViewer"> <TypeSignature Language="C#" Value="public class ByteViewer : System.Windows.Forms.TableLayoutPanel" /> <AssemblyInfo> @@ -18,8 +19,16 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.ComponentModel.Design.ByteViewer" /> provides an interface for viewing hexadecimal, ANSI, and Unicode formatted data.</para> + <para>The <see cref="T:System.ComponentModel.Design.DisplayMode" /> enumeration specifies the identifiers that are used to indicate the display mode to use. The <see cref="F:System.ComponentModel.Design.DisplayMode.Auto" /> display mode selects a default display mode based on the contents of the byte array. <see cref="T:System.ComponentModel.Design.ByteViewer" /> uses a simple algorithm to determine what kind of data is stored in the buffer. The hexadecimal <see cref="F:System.ComponentModel.Design.DisplayMode.Hexdump" /> view displays the hexadecimal values and corresponding byte representations (chars) in a read-only edit box. The default number of columns is 16. The <see cref="F:System.ComponentModel.Design.DisplayMode.Ansi" /> and <see cref="F:System.ComponentModel.Design.DisplayMode.Unicode" /> views show the byte array in a read-only edit box. In these views, NUL characters are replaced with Unicode block characters.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays byte arrays in hexadecimal, ANSI, and Unicode formats.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,8 +36,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.ByteViewer" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -43,9 +55,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the bytes in the buffer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -60,9 +75,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the display mode for the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -101,9 +119,13 @@ <Parameter Name="e" Type="System.Windows.Forms.LayoutEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.Windows.Forms.Control.Layout" /> event.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.LayoutEventArgs" /> that contains the event data.</param> </Docs> </Member> <Member MemberName="OnPaint"> @@ -153,9 +175,13 @@ <Parameter Name="path" Type="System.String" /> </Parameters> <Docs> - <param name="path">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Writes the raw data from the data buffer to a file.</para> + </summary> + <param name="path"> + <attribution license="cc4" from="Microsoft" modified="false" />The file path to save to. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -173,10 +199,15 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="source">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Handles the <see cref="E:System.Windows.Forms.ScrollBar.ValueChanged" /> event on the <see cref="T:System.ComponentModel.Design.ByteViewer" /> control's <see cref="T:System.Windows.Forms.ScrollBar" />.</para> + </summary> + <param name="source"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event. </param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.EventArgs" /> that contains the event data. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -193,9 +224,13 @@ <Parameter Name="bytes" Type="System.Byte[]" /> </Parameters> <Docs> - <param name="bytes">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the byte array to display in the viewer.</para> + </summary> + <param name="bytes"> + <attribution license="cc4" from="Microsoft" modified="false" />The byte array to display. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -212,9 +247,13 @@ <Parameter Name="mode" Type="System.ComponentModel.Design.DisplayMode" /> </Parameters> <Docs> - <param name="mode">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the current display mode.</para> + </summary> + <param name="mode"> + <attribution license="cc4" from="Microsoft" modified="false" />The display mode to set. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -231,9 +270,16 @@ <Parameter Name="path" Type="System.String" /> </Parameters> <Docs> - <param name="path">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The viewer loads the data to view from the specified file. This method throws an exception if the file load fails.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the file to display in the viewer.</para> + </summary> + <param name="path"> + <attribution license="cc4" from="Microsoft" modified="false" />The file path to load from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -250,9 +296,16 @@ <Parameter Name="line" Type="System.Int32" /> </Parameters> <Docs> - <param name="line">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="F:System.ComponentModel.Design.DisplayMode.Hexdump" /> display mode displays the buffer starting at the specified line. If the specified line is out of range, the start line is set to zero.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the current line for the <see cref="F:System.ComponentModel.Design.DisplayMode.Hexdump" /> view.</para> + </summary> + <param name="line"> + <attribution license="cc4" from="Microsoft" modified="false" />The current line to display from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -260,4 +313,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/CollectionEditor.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/CollectionEditor.xml index 3af334b85a2..6f8400598a1 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/CollectionEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/CollectionEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CollectionEditor" FullName="System.ComponentModel.Design.CollectionEditor"> <TypeSignature Language="C#" Value="public class CollectionEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface that can edit most types of collections at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,9 +25,13 @@ <Parameter Name="type" Type="System.Type" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.CollectionEditor" /> class using the specified collection type.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the collection for this editor to edit. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -42,8 +50,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Cancels changes to the collection.</para> + </summary> </Docs> </Member> <Member MemberName="CanRemoveInstance"> @@ -56,10 +67,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When implemented in a derived class, this method indicates whether the specified value can be removed from the collection. By default, this method always returns true.</para> + <para>This method is called when the user tries to remove an item that is an original member of the collection. This method is not called when removing items that were added in the current editing session because they are not yet part of the collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether original members of the collection can be removed.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The value to remove. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -74,9 +93,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method indicates whether multiple collection members can be selected within the collection editor dialog box.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether multiple collection items can be selected at once.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -90,9 +115,15 @@ <ReturnType>System.Type</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This property represents the data type of the items of the collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data type of each item in the collection.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -106,9 +137,15 @@ <ReturnType>System.Type</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This property represents the data type of the collection object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data type of the collection object.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -122,9 +159,12 @@ <ReturnType>System.ComponentModel.ITypeDescriptorContext</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a type descriptor that indicates the current context.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -139,9 +179,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new form to display and edit the current collection.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -156,9 +199,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You can retrieve the data type of the items of the collection from the <see cref="P:System.ComponentModel.Design.CollectionEditor.CollectionItemType" /> property, which is faster than this method.</para> + <para>This method does not need to be called by users, except in derived classes where this method has been overridden and implemented.</para> + <para>The default implementation of this method returns the data type of the Item property of the collection, if it exists.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data type that this collection contains.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -175,10 +226,14 @@ <Parameter Name="itemType" Type="System.Type" /> </Parameters> <Docs> - <param name="itemType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new instance of the specified collection item type.</para> + </summary> + <param name="itemType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of item to create. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -193,9 +248,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You can retrieve the data type of the items of the collection from the <see cref="P:System.ComponentModel.Design.CollectionEditor.NewItemTypes" /> property, which is faster than this method.</para> + <para>This method does not need to be called by users, except in derived classes where this method has been overridden and implemented.</para> + <para>The default implementation of this method returns the type of all the collection items in a Type array.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data types that this collection editor can contain.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -212,9 +275,13 @@ <Parameter Name="instance" Type="System.Object" /> </Parameters> <Docs> - <param name="instance">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Destroys the specified instance of the object.</para> + </summary> + <param name="instance"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to destroy. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -233,12 +300,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the specified object using the specified service provider and context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which editing services can be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to edit the value of. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -259,10 +332,14 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the display text for the given list item.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The list item for which to retrieve display text.</param> </Docs> </Member> <Member MemberName="GetEditStyle"> @@ -275,10 +352,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the edit style used by the <see cref="M:System.ComponentModel.Design.CollectionEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -295,10 +376,14 @@ <Parameter Name="editValue" Type="System.Object" /> </Parameters> <Docs> - <param name="editValue">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array of objects containing the specified collection.</para> + </summary> + <param name="editValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The collection to edit. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -319,10 +404,14 @@ <Parameter Name="instance" Type="System.Object" /> </Parameters> <Docs> - <param name="instance">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a list containing the given object</para> + </summary> + <param name="instance"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ArrayList" /> returned as an object.</param> </Docs> </Member> <Member MemberName="GetService"> @@ -335,10 +424,14 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the requested service, if it is available.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of service to retrieve. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -352,9 +445,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Override this property to display a different Help topic.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the Help keyword to display the Help topic or topic list for when the editor's dialog box Help button or the F1 key is pressed.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -368,9 +467,15 @@ <ReturnType>System.Type[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This property indicates the data types that can be added to the collection. By default, this returns a single type of <see cref="P:System.ComponentModel.Design.CollectionEditor.CollectionItemType" />. If more than one type is returned, the collection editor UI provides a way to choose which item type to create. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the available types of items that can be created for this collection.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -388,11 +493,19 @@ <Parameter Name="value" Type="System.Object[]" /> </Parameters> <Docs> - <param name="editValue">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If setting requires that a new object be created, the new object is returned. Otherwise, the <paramref name="editValue" /> parameter is returned.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the specified array as the items of the collection.</para> + </summary> + <param name="editValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The collection to edit. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of objects to set as the collection items. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -407,8 +520,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays the default Help topic for the collection editor.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -416,4 +532,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ComponentActionsType.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ComponentActionsType.xml index 8d38ab9fbfc..3fa967c6ca2 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ComponentActionsType.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ComponentActionsType.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ComponentActionsType" FullName="System.ComponentModel.Design.ComponentActionsType"> <TypeSignature Language="C#" Value="public enum ComponentActionsType" /> <AssemblyInfo> @@ -8,8 +9,43 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The following table describes the two options for associating an object-bound smart tag to a component.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Smart-tag model</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para>Pull</para> + </term> + <description> + <para>The class derived from <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> that is associated with the component overrides the <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" /> property to return the collection of smart tags for that component.</para> + </description> + </item> + <item> + <term> + <para>Push</para> + </term> + <description> + <para>A call to the <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Add" /> method explicitly associates the specified smart tags with the specified component.</para> + </description> + </item> + </list> + <para>For more information about these smart-tag models, see the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> and <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> classes.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the type of object-bound smart tag with respect to how it was associated with the component.</para> + </summary> </Docs> <Members> <Member MemberName="All"> @@ -22,7 +58,10 @@ <ReturnType>System.ComponentModel.Design.ComponentActionsType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Both types of smart tags.</para> + </summary> </Docs> </Member> <Member MemberName="Component"> @@ -35,7 +74,10 @@ <ReturnType>System.ComponentModel.Design.ComponentActionsType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Pull model smart tags only.</para> + </summary> </Docs> </Member> <Member MemberName="Service"> @@ -48,8 +90,11 @@ <ReturnType>System.ComponentModel.Design.ComponentActionsType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Push model smart tags only.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ComponentDesigner.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ComponentDesigner.xml index 3e1f1d7c673..735378ef696 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ComponentDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ComponentDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ComponentDesigner" FullName="System.ComponentModel.Design.ComponentDesigner"> <TypeSignature Language="C#" Value="public class ComponentDesigner : System.ComponentModel.Design.IComponentInitializer, System.ComponentModel.Design.IDesignerFilter, System.ComponentModel.Design.ITreeDesigner" /> <AssemblyInfo> @@ -20,8 +21,27 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> base designer class provides a simple designer that can extend the behavior of an associated component in design mode.</para> + <para> + <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> provides an empty <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface implementation, whose methods can be overridden to adjust the attributes, properties and events of the associated component at design time.</para> + <para>You can associate a designer with a type using a <see cref="T:System.ComponentModel.DesignerAttribute" />. For an overview of customizing design-time behavior, see <format type="text/html"><a href="d6ac8a6a-42fd-4bc8-bf33-b212811297e2">Extending Design-Time Support</a></format>.</para> + <para>The <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class implements a special behavior for the property descriptors of inherited components. An internal type named InheritedPropertyDescriptor is used by the default <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> implementation to stand in for properties that are inherited from a base class. There are two cases in which these property descriptors are added.</para> + <list type="ordered"> + <item> + <para>To the root object itself, which is returned by the <see cref="P:System.ComponentModel.Design.IDesignerHost.RootComponent" /> property, because you are inheriting from its base class.</para> + </item> + <item> + <para>To fields found in the base class of the root object. Public and protected fields from the base class are added to the designer so that they can be manipulated by the user.</para> + </item> + </list> + <para>The InheritedPropertyDescriptor class modifies the default value of a property, so that the default value is the current value at object instantiation. This is because the property is inherited from another instance. The designer defines resetting the property value as setting it to the value that was set by the inherited class. This value may differ from the default value stored in metadata.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends the design mode behavior of a component.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -29,8 +49,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -47,9 +70,12 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design-time action lists supported by the component associated with the designer.</para> + </summary> </Docs> </Member> <Member MemberName="AssociatedComponents"> @@ -59,9 +85,17 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This property indicates any components to copy or move along with the component managed by the designer during a copy, drag, or move operation.</para> + <para>If this collection contains references to other components in the current design mode document, those components will be copied along with the component managed by the designer during a copy operation.</para> + <para>When the component managed by the designer is selected, this collection is filled with any nested controls. This collection can also include other components, such as the buttons of a toolbar.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the collection of components associated with the component managed by the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -75,9 +109,18 @@ <ReturnType>System.ComponentModel.IComponent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.ComponentDesigner.Initialize(System.ComponentModel.IComponent)" /> method of <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> sets this property.</para> + <block subset="none" type="note"> + <para>When overriding the <see cref="M:System.ComponentModel.Design.ComponentDesigner.Initialize(System.ComponentModel.IComponent)" /> method, be sure to call the base class <see cref="M:System.ComponentModel.Design.ComponentDesigner.Initialize(System.ComponentModel.IComponent)" /> method before using this property.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the component this designer is designing.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -92,8 +135,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call <see cref="Overload:System.ComponentModel.Design.ComponentDesigner.Dispose" /> when you are finished using the <see cref="T:System.ComponentModel.Design.ComponentDesigner" />. The <see cref="Overload:System.ComponentModel.Design.ComponentDesigner.Dispose" /> method leaves the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> in an unusable state. After calling <see cref="Overload:System.ComponentModel.Design.ComponentDesigner.Dispose" />, you must release all references to the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> 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="Overload:System.ComponentModel.Design.ComponentDesigner.Dispose" /> before you release your last reference to the <see cref="T:System.ComponentModel.Design.ComponentDesigner" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> 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.ComponentDesigner" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -110,9 +162,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -127,8 +187,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>In Windows Forms and Web Forms designers, this method is invoked when a user double-clicks a component.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -143,8 +209,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method overrides <see cref="M:System.Object.Finalize" /> and cleans up resources by calling Dispose(false). Override Dispose(Boolean) to customize the cleanup.</para> + <para>Application code should not call this method; an object's Finalize method is automatically invoked during garbage collection, unless finalization by the garbage collector has been disabled by a call to the <see cref="M:System.GC.SuppressFinalize(System.Object)" /> method.</para> + <para>For more information, see <format type="text/html"><a href="fd376774-1643-499b-869e-9546a3aeea70">Finalize Methods and Destructors</a></format>, <format type="text/html"><a href="a17b0066-71c2-4ba4-9822-8e19332fc213">Cleaning Up Unmanaged Resources</a></format>, and <format type="text/html"><a href="8026cb68-fe93-43fc-96c1-c09ad7d64cd3">Overriding the Finalize Method</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Attempts to free resources by calling Dispose(false) before the object is reclaimed by garbage collection.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -162,9 +236,15 @@ </Parameters> <Docs> <param name="service">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation of this method requests the service from the site of the component.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Attempts to retrieve the specified type of service from the design mode site of the designer's component.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -178,9 +258,12 @@ <ReturnType>System.ComponentModel.InheritanceAttribute</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an attribute that indicates the type of inheritance of the associated component.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -194,9 +277,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether this component is inherited.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -213,9 +299,16 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The designer host calls this method when it is ready to use the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Prepares the designer to view, edit, and design the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component for this designer. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -235,9 +328,18 @@ <Parameter Name="defaultValues" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="defaultValues">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.ComponentDesigner.InitializeExistingComponent(System.Collections.IDictionary)" /> method is called when an existing component is being reinitialized. For example, this may occur after the user drags a component to another container. </para> + <para>You may use the <paramref name="defaultValues" /> dictionary to apply recommended defaults to properties; however, you should not modify component properties aside from those stored in the dictionary, because this existing component may already have properties set on it. </para> + <para>The default implementation of this method does nothing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Reinitializes an existing component.</para> + </summary> + <param name="defaultValues"> + <attribution license="cc4" from="Microsoft" modified="false" />A name/value dictionary of default values to apply to properties. May be null if no default values are specified.</param> </Docs> </Member> <Member MemberName="InitializeNewComponent"> @@ -253,9 +355,18 @@ <Parameter Name="defaultValues" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="defaultValues">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.ComponentDesigner.InitializeNewComponent(System.Collections.IDictionary)" /> method is called when a component is first initialized, typically after being first added to a design surface. </para> + <para>You may perform any necessary initialization of this component, and you may ignore the <paramref name="defaultValues" /> dictionary altogether.</para> + <para>The default implementation of this method does nothing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a newly created component.</para> + </summary> + <param name="defaultValues"> + <attribution license="cc4" from="Microsoft" modified="false" />A name/value dictionary of default values to apply to properties. May be null if no default values are specified.</param> </Docs> </Member> <Member MemberName="InitializeNonDefault"> @@ -266,8 +377,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called when the designer is associated with a control that is not in its default state, such as a control that you paste or move with a drag-and-drop operation onto the designer. This method provides an opportunity for implementers to modify or shadow the properties of the component rather than initialize the properties for the component to their defaults. This method is called after the other initialization functions.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the settings for an imported component that is already initialized to settings other than the defaults.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -289,10 +406,14 @@ <Parameter Name="toInvoke" Type="System.ComponentModel.Design.ComponentDesigner" /> </Parameters> <Docs> - <param name="toInvoke">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.ComponentModel.InheritanceAttribute" /> of the specified <see cref="T:System.ComponentModel.Design.ComponentDesigner" />.</para> + </summary> + <param name="toInvoke"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> whose inheritance attribute to retrieve. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -307,8 +428,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="M:System.ComponentModel.Design.ComponentDesigner.OnSetComponentDefaults" /> is called when the designer is initialized. This allows the designer to provide default values for the base component.</para> + <para>This method is called only once: when you first create the component by dragging it from the Toolbox to the design surface. Subsequent initializations of the designer do not invoke this method.</para> + <para>The default implementation of this method sets the default property of the component to the name of the component if the default property is a string and the property is not already set. This method can be implemented in a derived class to customize the initialization of the component that this designer is designing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the default properties for the component.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -330,9 +460,15 @@ <ReturnType>System.ComponentModel.IComponent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This property provides a generic mechanism for discovering parent relationships within designers, and is used by the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> object's <see cref="T:System.ComponentModel.Design.ITreeDesigner" /> interface implementation. This property should only return null when this designer is the root component. The default implementation of this property returns the root component for all components that are not the root component, and it returns null for the root component.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the parent component for this designer.</para> + </summary> </Docs> </Member> <Member MemberName="PostFilterAttributes"> @@ -345,9 +481,17 @@ <Parameter Name="attributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="attributes">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method provides a way to change or remove the items within the dictionary of attributes that are exposed through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + <para>The keys in the dictionary of attributes are the type identifiers of the attributes, as specified by the value of their <see cref="P:System.Attribute.TypeId" /> property. The objects are of type <see cref="T:System.ComponentModel.PropertyDescriptor" />. This method is called immediately after the <see cref="M:System.ComponentModel.Design.ComponentDesigner.PreFilterAttributes(System.Collections.IDictionary)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to change or remove items from the set of attributes that it exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="attributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The attributes for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -364,9 +508,17 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method provides a way to change or remove the items within the dictionary of events that are exposed through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + <para>The keys in the dictionary of events are the names of the events. The objects are of type <see cref="T:System.ComponentModel.PropertyDescriptor" />. This method is called immediately after the <see cref="M:System.ComponentModel.Design.ComponentDesigner.PreFilterEvents(System.Collections.IDictionary)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to change or remove items from the set of events that it exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />The events for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -383,9 +535,17 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method provides a way to change or remove the items within the dictionary of properties that are exposed through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + <para>The keys in the dictionary of properties are the names of the properties. The objects are of type <see cref="T:System.ComponentModel.PropertyDescriptor" />. This method is called immediately after the <see cref="M:System.ComponentModel.Design.ComponentDesigner.PreFilterProperties(System.Collections.IDictionary)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to change or remove items from the set of properties that it exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The properties for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -402,9 +562,17 @@ <Parameter Name="attributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="attributes">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method provides a way to add items to the dictionary of attributes that a designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + <para>The keys in the dictionary of attributes are the type identifiers of the attributes, as specified by the value of their <see cref="P:System.Attribute.TypeId" /> property. The objects are of type <see cref="T:System.ComponentModel.PropertyDescriptor" />. This method is called immediately before the <see cref="M:System.ComponentModel.Design.ComponentDesigner.PostFilterAttributes(System.Collections.IDictionary)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to add to the set of attributes that it exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="attributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The attributes for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -421,9 +589,17 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method provides a way to add items to the dictionary of events that a designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + <para>The keys in the dictionary of events are the names of the events. The objects are of type <see cref="T:System.ComponentModel.PropertyDescriptor" />. This method is called immediately before the <see cref="M:System.ComponentModel.Design.ComponentDesigner.PostFilterEvents(System.Collections.IDictionary)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to add to the set of events that it exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />The events for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -440,9 +616,17 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method provides a way to add items to the dictionary of properties that a designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + <para>The keys in the dictionary of properties are the names of the properties. The objects are of type <see cref="T:System.ComponentModel.PropertyDescriptor" />. This method is called immediately before the <see cref="M:System.ComponentModel.Design.ComponentDesigner.PostFilterProperties(System.Collections.IDictionary)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to add to the set of properties that it exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The properties for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -461,11 +645,20 @@ <Parameter Name="newValue" Type="System.Object" /> </Parameters> <Docs> - <param name="member">To be added.</param> - <param name="oldValue">To be added.</param> - <param name="newValue">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call this method only when you affect component properties directly and not through the accessors provided by <see cref="T:System.ComponentModel.MemberDescriptor" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> that this component has been changed.</para> + </summary> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.MemberDescriptor" /> that indicates the member that has been changed. </param> + <param name="oldValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The old value of the member. </param> + <param name="newValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The new value of the member. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -482,9 +675,16 @@ <Parameter Name="member" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="member">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call this method only when you affect component properties directly and not through accessors provided by <see cref="T:System.ComponentModel.MemberDescriptor" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> that this component is about to be changed.</para> + </summary> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.MemberDescriptor" /> that indicates the member that is about to be changed. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -498,9 +698,12 @@ <ReturnType>System.ComponentModel.Design.ComponentDesigner+ShadowPropertyCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of property values that override user settings.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -521,9 +724,16 @@ <Parameter Name="attributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="attributes">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.ComponentModel.Design.IDesignerFilter.PostFilterAttributes(System.Collections.IDictionary)" /> method.</para> + </summary> + <param name="attributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Attribute" /> objects for the class of the component. The keys in the dictionary of attributes are the <see cref="P:System.Attribute.TypeId" /> values of the attributes.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PostFilterEvents"> @@ -540,9 +750,16 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.ComponentModel.Design.IDesignerFilter.PostFilterEvents(System.Collections.IDictionary)" /> method.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.EventDescriptor" /> objects that represent the events of the class of the component. The keys in the dictionary of events are event names.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PostFilterProperties"> @@ -559,9 +776,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.ComponentModel.Design.IDesignerFilter.PostFilterProperties(System.Collections.IDictionary)" /> method.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.PropertyDescriptor" /> objects that represent the properties of the class of the component. The keys in the dictionary of properties are property names.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PreFilterAttributes"> @@ -578,9 +802,16 @@ <Parameter Name="attributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="attributes">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.ComponentModel.Design.IDesignerFilter.PreFilterAttributes(System.Collections.IDictionary)" /> method.</para> + </summary> + <param name="attributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Attribute" /> objects for the class of the component. The keys in the dictionary of attributes are the <see cref="P:System.Attribute.TypeId" /> values of the attributes.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PreFilterEvents"> @@ -597,9 +828,16 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.ComponentModel.Design.IDesignerFilter.PreFilterEvents(System.Collections.IDictionary)" /> method.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.EventDescriptor" /> objects that represent the events of the class of the component. The keys in the dictionary of events are event names.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PreFilterProperties"> @@ -616,9 +854,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.ComponentModel.Design.IDesignerFilter.PreFilterProperties(System.Collections.IDictionary)" /> method.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.PropertyDescriptor" /> objects that represent the properties of the class of the component. The keys in the dictionary of properties are property names.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.ITreeDesigner.Children"> @@ -631,9 +876,15 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.ITreeDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="P:System.ComponentModel.Design.ITreeDesigner.Children" /> property.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.ITreeDesigner.Parent"> @@ -646,9 +897,15 @@ <ReturnType>System.ComponentModel.Design.IDesigner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.ITreeDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="P:System.ComponentModel.Design.ITreeDesigner.Parent" /> property.</para> + </summary> </Docs> </Member> <Member MemberName="Verbs"> @@ -658,9 +915,19 @@ <ReturnType>System.ComponentModel.Design.DesignerVerbCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method returns null if the component has no design-time verbs.</para> + <para>The design-time environment typically displays verbs returned by this method in a shortcut (right-click) menu. When a user selects one of the verbs, the <see cref="M:System.ComponentModel.Design.MenuCommand.Invoke" /> method of the corresponding <see cref="T:System.ComponentModel.Design.DesignerVerb" /> is invoked.</para> + <block subset="none" type="note"> + <para>A design-time environment typically provides a <ui>Properties</ui> command on a component's shortcut menu. Therefore, do not include such an entry in the collection of designer-specified verbs.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design-time verbs supported by the component that is associated with the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -668,4 +935,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DateTimeEditor.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DateTimeEditor.xml index 9bea1bee9e8..332292dbf65 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DateTimeEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DateTimeEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DateTimeEditor" FullName="System.ComponentModel.Design.DateTimeEditor"> <TypeSignature Language="C#" Value="public class DateTimeEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This date time editor is a <see cref="T:System.Drawing.Design.UITypeEditor" /> suitable for visually editing <see cref="T:System.DateTime" /> objects.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DateTimeEditor" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,12 +46,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the specified object value using the editor style provided by GetEditorStyle. A service provider is provided so that any required editing services can be obtained.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />A type descriptor context that can be used to provide additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which editing services may be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the value being edited. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,10 +74,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the editing style of the <see cref="Overload:System.ComponentModel.Design.DateTimeEditor.EditValue" /> method. If the method is not supported, this will return None.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />A type descriptor context that can be used to provide additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -72,4 +89,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurface.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurface.xml index 2253dab97e7..93c52d3bb8e 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurface.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurface.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignSurface" FullName="System.ComponentModel.Design.DesignSurface"> <TypeSignature Language="C#" Value="public class DesignSurface : IDisposable, IServiceProvider" /> <AssemblyInfo> @@ -16,8 +17,210 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignSurface" /> class implements what the user perceives as a designer. <see cref="T:System.ComponentModel.Design.DesignSurface" /> is the user interface the user manipulates to change design-time features. <see cref="T:System.ComponentModel.Design.DesignSurface" /> provides a completely self-contained design surface.</para> + <para>The <see cref="T:System.ComponentModel.Design.DesignSurface" /> class may be used as a stand-alone designer, or it may be coupled with the <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> class to provide a common implementation for an application that hosts multiple <see cref="T:System.ComponentModel.Design.DesignSurface" /> objects.</para> + <para>The <see cref="T:System.ComponentModel.Design.DesignSurface" /> class can be used by itself, or the user can derive a new class from it and augment the behavior.</para> + <para>The <see cref="T:System.ComponentModel.Design.DesignSurface" /> class provides several design-time services automatically. The <see cref="T:System.ComponentModel.Design.DesignSurface" /> class adds all of its services in its constructor. Most of these services can be overridden by replacing them in the protected <see cref="P:System.ComponentModel.Design.DesignSurface.ServiceContainer" /> property. To replace a service, override the constructor, call base, and make any changes through the protected <see cref="P:System.ComponentModel.Design.DesignSurface.ServiceContainer" /> property. All services that are added to the service container and that implement <see cref="T:System.IDisposable" /> are disposed when the design surface is disposed. The default set of replaceable services that the <see cref="T:System.ComponentModel.Design.DesignSurface" /> class provides is shown in the following table.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Service</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IExtenderProviderService" /> + </para> + </term> + <description> + <para>Enables objects that are not part of the container’s components collection to provide their own extender providers.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IExtenderListService" /> + </para> + </term> + <description> + <para>Used by <see cref="T:System.ComponentModel.TypeDescriptor" /> to get a list of extender providers. With this service, extender providers can live outside of the container.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.ITypeDescriptorFilterService" /> + </para> + </term> + <description> + <para>Provides designer metadata hooks. This is the primary interface for metadata filtering.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.ISelectionService" /> + </para> + </term> + <description> + <para>Provides a way to select components in the designer.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IReferenceService" /> + </para> + </term> + <description> + <para>Provides a way to get a name for objects, even when those objects are not sited.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.DesignSurface" /> + </para> + </term> + <description> + <para>Offers the design surface itself as a service.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.DesignerOptionService" /> </para> + </term> + <description> + <para>Provides a base class for getting and setting option values for a designer.</para> + </description> + </item> + </list> + <para>The following table shows the non-replaceable services provided by default.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Service</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> + </para> + </term> + <description> + <para>Raises events as changes are made to components.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IDesignerHost" /> + </para> + </term> + <description> + <para>Controls access to types, services, and transactions. Master interface for designers.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.IContainer" /> + </para> + </term> + <description> + <para>Owns the set of components that are being designed. Each designer has an <see cref="T:System.ComponentModel.IContainer" /> that owns the components.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IServiceContainer" /> + </para> + </term> + <description> + <para>Derives from <see cref="T:System.IServiceProvider" /> and provides a way to add and remove services from the designer.</para> + </description> + </item> + </list> + <para>In addition to these services, the <see cref="T:System.ComponentModel.Design.DesignSurface" /> class also provides a single service that is available through a component’s site. This service is unique for each component. The following table shows the services that cannot be replaced.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Service</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IDictionaryService" /> + </para> + </term> + <description> + <para>A generic dictionary of key/value pairs that can be used to store arbitrary data about a component.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.INestedContainer" /> + </para> + </term> + <description> + <para>A container that enables a component to add additional child components to the designer. These components will be part of the design surface, but will not participate in serialization. This is useful when you want to design a control that is capable of exposing a region of itself in a designer, but you do not want the region to participate in serialization.</para> + </description> + </item> + </list> + <para>In addition to <see cref="T:System.ComponentModel.ISite" />, the site also implements the following interfaces. </para> + <block subset="none" type="note"> + <para>Check for the existence of these interfaces, rather than use indiscriminate casting, because other site implementations may not implement them.</para> + </block> + <list type="table"> + <listheader> + <item> + <term> + <para>Service</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IServiceContainer" /> + </para> + </term> + <description> + <para>Provides a way to get to the container of site-specific services. For example, <see cref="T:System.ComponentModel.Design.IDictionaryService" /> is a site-specific service. With this service, you can add additional site-specific services.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Presents a user interface for designing components.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -28,8 +231,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignSurface" /> class.</para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -42,9 +248,16 @@ <Parameter Name="parentProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="parentProvider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When <paramref name="parentProvide " />is present, designers contained within the surface can retrieve services from the application.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignSurface" /> class.</para> + </summary> + <param name="parentProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent service provider, or null if there is no parent used to resolve services.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -57,9 +270,19 @@ <Parameter Name="rootComponentType" Type="System.Type" /> </Parameters> <Docs> - <param name="rootComponentType">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When you use the <see cref="M:System.ComponentModel.Design.DesignSurface.#ctor(System.Type)" /> constructor, it creates a simple designer loader that, in turn, creates a component of the given type and then ends the loading process. This is a straightforward way to create a designer, under the assumption that all saving of state will be done externally. Internally, this calls <see cref="Overload:System.ComponentModel.Design.DesignSurface.BeginLoad" /> and passes the root component type.</para> + <block subset="none" type="note"> + <para>The <see cref="M:System.ComponentModel.Design.DesignSurface.#ctor(System.Type)" /> overload is not affected by <see cref="T:System.Windows.Forms.Design.DesignerOptions" />. The <see cref="T:System.Windows.Forms.Design.DesignerOptions" /> must be in the service container before the design surface loads. If you need access to <see cref="T:System.Windows.Forms.Design.DesignerOptions" />, call the empty constructor, add the <see cref="T:System.Windows.Forms.Design.DesignerOptions" /> to the <see cref="P:System.ComponentModel.Design.DesignSurface.ServiceContainer" /> and call <see cref="M:System.ComponentModel.Design.DesignSurface.BeginLoad(System.Type)" /> with <paramref name="rootComponentType" />.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignSurface" /> class.</para> + </summary> + <param name="rootComponentType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of root component to create.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -73,10 +296,18 @@ <Parameter Name="rootComponentType" Type="System.Type" /> </Parameters> <Docs> - <param name="parentProvider">To be added.</param> - <param name="rootComponentType">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Using the <see cref="M:System.ComponentModel.Design.DesignSurface.#ctor(System.IServiceProvider,System.Type)" /> constructor creates a simple designer loader that creates a component of the given type and then ends the loading process. This is a straightforward way to create a designer, under the assumption that all saving of state will be done externally. Internally, this calls <see cref="Overload:System.ComponentModel.Design.DesignSurface.BeginLoad" /> and passes the root component type.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignSurface" /> class.</para> + </summary> + <param name="parentProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent service provider, or null if there is no parent used to resolve services.</param> + <param name="rootComponentType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of root component to create.</param> </Docs> </Member> <Member MemberName="BeginLoad"> @@ -92,9 +323,17 @@ <Parameter Name="loader" Type="System.ComponentModel.Design.Serialization.DesignerLoader" /> </Parameters> <Docs> - <param name="loader">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Designer loading can be asynchronous, so the loading may continue to progress after this call has returned. Attach an event handler to the <see cref="E:System.ComponentModel.Design.IDesignerHost.LoadComplete" /> event to be notified when the design surface has completed loading.</para> + <para>After <see cref="Overload:System.ComponentModel.Design.DesignSurface.BeginLoad" /> is called, you can immediately obtain the view for the designer, because designer loaders must provide at least the root component when loading asynchronously.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Begins the loading process with the given designer loader.</para> + </summary> + <param name="loader"> + <attribution license="cc4" from="Microsoft" modified="false" />The designer loader to use for loading the designer.</param> </Docs> </Member> <Member MemberName="BeginLoad"> @@ -110,9 +349,20 @@ <Parameter Name="rootComponentType" Type="System.Type" /> </Parameters> <Docs> - <param name="rootComponentType">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When <paramref name="rootComponentType" /> is specified, a default designer loader that simply creates an instance of <paramref name="rootComponentType" /> will be used. Designer loading can be asynchronous, so the loading may continue to progress after this call has returned. Attach an event handler to the <see cref="E:System.ComponentModel.Design.IDesignerHost.LoadComplete" /> event to be notified when the design surface has completed loading.</para> + <para>After <see cref="M:System.ComponentModel.Design.DesignSurface.BeginLoad(System.Type)" /> is called, you can immediately obtain the view for the designer, because designer loaders must provide at least the root component when loading asynchronously.</para> + <block subset="none" type="note"> + <para>The <see cref="M:System.ComponentModel.Design.DesignSurface.BeginLoad(System.Type)" /> method creates an instance of the component type and initializes a designer for this instance. The <see cref="E:System.ComponentModel.Design.DesignSurface.Loaded" /> event is raised before this method returns.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Begins the loading process.</para> + </summary> + <param name="rootComponentType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of component to create in design mode.</param> </Docs> </Member> <Member MemberName="ComponentContainer"> @@ -125,9 +375,15 @@ <ReturnType>System.ComponentModel.IContainer</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.DesignSurface.ComponentContainer" /> property holds all objects that are currently in design mode. When components are added to <see cref="P:System.ComponentModel.Design.DesignSurface.ComponentContainer" />, their designer, if any, is loaded. The component is sited with a site that provides full access to the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.ComponentModel.IContainer" /> implementation within the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="CreateComponent"> @@ -148,10 +404,17 @@ <Parameter Name="componentType" Type="System.Type" /> </Parameters> <Docs> - <param name="componentType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignSurface.CreateComponent(System.Type)" /> method is called by the design surface’s <see cref="Overload:System.ComponentModel.Design.IDesignerHost.CreateComponent" /> method to create an instance of a component. The component should be created and added to the public container on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of a component.</para> + </summary> + <param name="componentType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of component to create.</param> </Docs> </Member> <Member MemberName="CreateDesigner"> @@ -168,11 +431,22 @@ <Parameter Name="rootDesigner" Type="System.Boolean" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="rootDesigner">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignSurface.CreateDesigner(System.ComponentModel.IComponent,System.Boolean)" /> method is called by the design surface’s <see cref="T:System.ComponentModel.IContainer" /> when a component is added to the container. This method creates a designer, but does not initialize it. When it returns, the designer is initialized by the container.</para> + <para> + <see cref="M:System.ComponentModel.Design.DesignSurface.CreateDesigner(System.ComponentModel.IComponent,System.Boolean)" /> can create two different types of designers: root designers and normal designers. A root designer is a designer for the root component in the design surface, which by definition is the first component added to the container. Root designers differ from normal designers because they are responsible for the user interface presented to the end user. Root designers typically coordinate with the rest of the designers on a design surface to provide this interface.</para> + <para>The default implementation of this method delegates to <see cref="T:System.ComponentModel.TypeDescriptor" />, passing in <see cref="T:System.ComponentModel.Design.IRootDesigner" /> as the designer type for root designers, or <see cref="T:System.ComponentModel.Design.IDesigner" /> for normal designers. You can override this method to request a specific type of designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a designer when a component is added to the container.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component for which the designer should be created.</param> + <param name="rootDesigner"> + <attribution license="cc4" from="Microsoft" modified="false" />true to create a root designer; false to create a normal designer.</param> </Docs> </Member> <Member MemberName="CreateInstance"> @@ -188,10 +462,17 @@ <Parameter Name="type" Type="System.Type" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If <paramref name="type" /> is an <see cref="T:System.ComponentModel.IComponent" />, <see cref="M:System.ComponentModel.Design.DesignSurface.CreateInstance(System.Type)" /> searches for a constructor of type <see cref="T:System.ComponentModel.IContainer" /> first, followed by an empty constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of the given type.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The type to create.</param> </Docs> </Member> <Member MemberName="CreateNestedContainer"> @@ -207,10 +488,17 @@ <Parameter Name="owningComponent" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="owningComponent">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adding a component to a nested container creates its designer and makes it eligible for all services available from the design surface. Components added to nested containers do not participate in serialization. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a container suitable for nesting controls or components.</para> + </summary> + <param name="owningComponent"> + <attribution license="cc4" from="Microsoft" modified="false" />The component that manages the nested container.</param> </Docs> </Member> <Member MemberName="CreateNestedContainer"> @@ -227,11 +515,20 @@ <Parameter Name="containerName" Type="System.String" /> </Parameters> <Docs> - <param name="owningComponent">To be added.</param> - <param name="containerName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adding a component to a nested container creates its designer and makes it eligible for all services available from the design surface. Components added to nested containers do not participate in serialization. </para> + <para>You can provide an additional name for the <see cref="M:System.ComponentModel.Design.DesignSurface.CreateNestedContainer(System.ComponentModel.IComponent,System.String)" /> method by passing a value into <paramref name="containerName" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a container suitable for nesting controls or components.</para> + </summary> + <param name="owningComponent"> + <attribution license="cc4" from="Microsoft" modified="false" />The component that manages the nested container.</param> + <param name="containerName"> + <attribution license="cc4" from="Microsoft" modified="false" />An additional name for the nested container.</param> </Docs> </Member> <Member MemberName="Dispose"> @@ -245,8 +542,21 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The public <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose" /> method follows the standard <see cref="T:System.IDisposable" /> pattern. Calling this method destroys the design surface. The protected version of this method is virtual and follows the normal <see cref="T:System.IDisposable" /> pattern. </para> + <block subset="none" type="note"> + <para>Because <see cref="T:System.ComponentModel.Design.DesignSurface" /> does not have any native code to clean up, it does not have a finalizer that calls <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose(System.Boolean)" />. If you need to call <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose(System.Boolean)" />, you must add a finalizer yourself.</para> + </block> + <para>Call <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose" /> when you are finished using the <see cref="T:System.ComponentModel.Design.DesignSurface" />. The <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose" /> method leaves the <see cref="T:System.ComponentModel.Design.DesignSurface" /> in an unusable state. After calling <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose" />, you must release all references to the <see cref="T:System.ComponentModel.Design.DesignSurface" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Design.DesignSurface" /> 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.DesignSurface.Dispose" /> before you release your last reference to the <see cref="T:System.ComponentModel.Design.DesignSurface" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Design.DesignSurface" /> object's Finalize method.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the resources used by the <see cref="T:System.ComponentModel.Design.DesignSurface" />.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -262,9 +572,21 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The public <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose" /> method follows the standard <see cref="T:System.IDisposable" /> pattern. Calling this method destroys the design surface. The protected version of this method is virtual and follows the normal <see cref="T:System.IDisposable" /> pattern. </para> + <block subset="none" type="note"> + <para>Because <see cref="T:System.ComponentModel.Design.DesignSurface" /> does not have any native code to clean up, it does not have a finalizer that calls <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose(System.Boolean)" />. If you need to call <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose(System.Boolean)" />, you must add a finalizer yourself.</para> + </block> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.ComponentModel.Design.DesignSurface" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the resources used by the <see cref="T:System.ComponentModel.Design.DesignSurface" />.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param> </Docs> </Member> <Member MemberName="Disposed"> @@ -277,8 +599,14 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The surface is only disposed when the public <see cref="M:System.ComponentModel.Design.DesignSurface.Dispose" /> method on <see cref="T:System.ComponentModel.Design.DesignSurface" /> is called.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the design surface is disposed.</para> + </summary> </Docs> </Member> <Member MemberName="Flush"> @@ -292,8 +620,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignSurface.Flush" /> method can be called to push changes made to the design surface down to the serializer. This ensures that the design surface and its serialized state are synchronized. The actual implementation of this method is forwarded to the designer loader associated with design surface. The designer loader may choose to defer changes until <see cref="M:System.ComponentModel.Design.DesignSurface.Flush" /> is called, or it may choose to keep the serialized data up to date with all user changes. The <see cref="M:System.ComponentModel.Design.DesignSurface.Flush" /> method ensures that regardless of the model the designer loader chooses to use, the serialized state is synchronized with the actual design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes changes to the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="Flushed"> @@ -306,8 +640,14 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The designer loader is flushed first, and then the <see cref="E:System.ComponentModel.Design.DesignSurface.Flushed" /> event is raised.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a call is made to the <see cref="M:System.ComponentModel.Design.DesignSurface.Flush" /> method of <see cref="T:System.ComponentModel.Design.DesignSurface" />.</para> + </summary> </Docs> </Member> <Member MemberName="GetService"> @@ -323,10 +663,17 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignSurface.GetService(System.Type)" /> method retrieves a service in the design surface’s service container. In addition, this will forward to any service provider that was given to the design surface at construction time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a service from the service container.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of service to retrieve. </param> </Docs> </Member> <Member MemberName="IsLoaded"> @@ -339,9 +686,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the design surface is currently loaded.</para> + </summary> </Docs> </Member> <Member MemberName="Loaded"> @@ -354,8 +704,18 @@ <ReturnType>System.ComponentModel.Design.LoadedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.ComponentModel.Design.DesignSurface.Loaded" /> event is raised for successful loads as well as unsuccessful ones. If code in this event handler throws an exception, the designer is unloaded.</para> + <para>The <see cref="T:System.ComponentModel.Design.LoadedEventArgs" /> object can be used to determine if loading succeeded, and it can also provide a list of errors that occurred during the load. </para> + <block subset="none" type="note"> + <para>Errors can occur for successful loads as well, provided that the serialization system can tolerate errors.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the designer load has completed.</para> + </summary> </Docs> </Member> <Member MemberName="LoadErrors"> @@ -368,9 +728,12 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a collection of loading errors or a void collection.</para> + </summary> </Docs> </Member> <Member MemberName="Loading"> @@ -383,8 +746,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the designer is about to be loaded.</para> + </summary> </Docs> </Member> <Member MemberName="OnLoaded"> @@ -400,9 +766,13 @@ <Parameter Name="e" Type="System.ComponentModel.Design.LoadedEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.DesignSurface.Loaded" /> event.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.LoadedEventArgs" /> that contains the event data.</param> </Docs> </Member> <Member MemberName="OnLoading"> @@ -418,9 +788,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.DesignSurface.Loading" /> event.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param> </Docs> </Member> <Member MemberName="OnUnloaded"> @@ -436,9 +810,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.DesignSurface.Unloaded" /> event.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param> </Docs> </Member> <Member MemberName="OnUnloading"> @@ -454,9 +832,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.DesignSurface.Unloading" /> event.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param> </Docs> </Member> <Member MemberName="OnViewActivate"> @@ -472,9 +854,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.DesignSurface.ViewActivated" /> event.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param> </Docs> </Member> <Member MemberName="ServiceContainer"> @@ -487,9 +873,15 @@ <ReturnType>System.ComponentModel.Design.ServiceContainer</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>At construction time, <see cref="T:System.ComponentModel.Design.DesignSurface" /> adds default services into this service container. You can leave the default services in their present state, or you can remove them and replace them with your own. The default services are all demand-created, so there is no loss in performance for adding them at construction time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the service container.</para> + </summary> </Docs> </Member> <Member MemberName="Unloaded"> @@ -502,8 +894,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a designer has finished unloading.</para> + </summary> </Docs> </Member> <Member MemberName="Unloading"> @@ -516,8 +911,14 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When a designer unloads, the entire state for that designer is destroyed, including the designer’s view. The view should be unparented at this time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a designer is about to unload.</para> + </summary> </Docs> </Member> <Member MemberName="View"> @@ -530,9 +931,16 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.ComponentModel.Design.DesignSurface.BeginLoad" /> method must be called beforehand to start the loading process. It is possible to return a view before the designer loader finishes loading because the root designer, which supplies the view, is the first object created by the designer loader. If a view is unavailable, <see cref="Overload:System.ComponentModel.Design.DesignSurface.BeginLoad" /> raises an exception. </para> + <para>The notion of a view technology is obsolete. But, it remains in the interfaces for root designers for backward compatibility. Its use is hidden from anyone using <see cref="T:System.ComponentModel.Design.DesignSurface" /> objects. The <see cref="P:System.ComponentModel.Design.DesignSurface.View" /> property hides view technologies by passing the supported technologies back into the root designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the view for the root designer.</para> + </summary> </Docs> </Member> <Member MemberName="ViewActivated"> @@ -545,9 +953,15 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If you want to support the <see cref="M:System.ComponentModel.Design.IDesignerHost.Activate" /> method, your event handler should activate the window for this design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the <see cref="M:System.ComponentModel.Design.IDesignerHost.Activate" /> method has been called on <see cref="T:System.ComponentModel.Design.IDesignerHost" />.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceCollection.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceCollection.xml index e60952b2fa3..086152ef71d 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignSurfaceCollection" FullName="System.ComponentModel.Design.DesignSurfaceCollection"> <TypeSignature Language="C#" Value="public sealed class DesignSurfaceCollection : System.Collections.ICollection" /> <AssemblyInfo> @@ -13,8 +14,14 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This class provides a read-only collection of design surfaces.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Contains a collection of design surfaces. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName="CopyTo"> @@ -31,10 +38,15 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the collection members to the specified <see cref="T:System.ComponentModel.Design.DesignSurface" /> array beginning at the specified destination index.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The array to copy collection members to.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The destination index to begin copying to.</param> </Docs> </Member> <Member MemberName="Count"> @@ -47,9 +59,12 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the total number of design surfaces in the <see cref="T:System.ComponentModel.Design.DesignSurfaceCollection" />.</para> + </summary> </Docs> </Member> <Member MemberName="GetEnumerator"> @@ -63,9 +78,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an enumerator that can iterate through the <see cref="T:System.ComponentModel.Design.DesignSurfaceCollection" /> instance.</para> + </summary> </Docs> </Member> <Member MemberName="Item"> @@ -101,10 +119,18 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignSurfaceCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)" /> method.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional <see cref="T:System.Array" /> that is the destination of the values copied from <see cref="T:System.ComponentModel.Design.DesignSurfaceCollection" />.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The index in <paramref name="array" /> where copying begins.</param> </Docs> </Member> <Member MemberName="System.Collections.ICollection.Count"> @@ -117,9 +143,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignSurfaceCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="P:System.Collections.ICollection.Count" /> property.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.ICollection.IsSynchronized"> @@ -132,9 +164,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignSurfaceCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="P:System.Collections.ICollection.IsSynchronized" /> property.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.ICollection.SyncRoot"> @@ -147,9 +185,15 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignSurfaceCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="P:System.Collections.ICollection.SyncRoot" /> property.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IEnumerable.GetEnumerator"> @@ -163,10 +207,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignSurfaceCollection" /> instance is cast to an <see cref="T:System.Collections.IEnumerator" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.Collections.IEnumerable.GetEnumerator" /> method.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceEventArgs.xml index 2c91cc3a216..2e22ab3a313 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignSurfaceEventArgs" FullName="System.ComponentModel.Design.DesignSurfaceEventArgs"> <TypeSignature Language="C#" Value="public class DesignSurfaceEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:System.ComponentModel.Design.DesignSurfaceManager.DesignSurfaceCreated" /> event.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +27,13 @@ <Parameter Name="surface" Type="System.ComponentModel.Design.DesignSurface" /> </Parameters> <Docs> - <param name="surface">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignSurfaceEventArgs" /> class.</para> + </summary> + <param name="surface"> + <attribution license="cc4" from="Microsoft" modified="false" />The design surface that is being created.</param> </Docs> </Member> <Member MemberName="Surface"> @@ -38,10 +46,13 @@ <ReturnType>System.ComponentModel.Design.DesignSurface</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design surface that is being created.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceEventHandler.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceEventHandler.xml index d1bd36b6165..833c9147ca8 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceEventHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignSurfaceEventHandler" FullName="System.ComponentModel.Design.DesignSurfaceEventHandler"> <TypeSignature Language="C#" Value="public delegate void DesignSurfaceEventHandler(object sender, DesignSurfaceEventArgs e);" /> <AssemblyInfo> @@ -17,7 +18,13 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When you create a <see cref="T:System.ComponentModel.Design.DesignSurfaceEventHandler" /> delegate, you identify a method to handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:System.ComponentModel.Design.DesignSurfaceManager.DesignSurfaceCreated" /> event of a <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> class. This class cannot be inherited.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceManager.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceManager.xml index 6ea6f73cbc5..c8cb3966a9a 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceManager.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignSurfaceManager.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignSurfaceManager" FullName="System.ComponentModel.Design.DesignSurfaceManager"> <TypeSignature Language="C#" Value="public class DesignSurfaceManager : IDisposable, IServiceProvider" /> <AssemblyInfo> @@ -16,8 +17,15 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> class is designed to be a container of <see cref="T:System.ComponentModel.Design.DesignSurface" /> objects. It provides common services that handle event routing between designers, property windows, and other global objects. Using <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> is optional, but it is recommended if you intend to have several designer windows.</para> + <para>The <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> class provides several design-time services automatically. You can override each of these services by replacing them in the protected <see cref="P:System.ComponentModel.Design.DesignSurfaceManager.ServiceContainer" /> property. To replace a service, override the constructor, call base, and make any changes through the protected <see cref="P:System.ComponentModel.Design.DesignSurfaceManager.ServiceContainer" /> property. All services added to the service container that implement the <see cref="T:System.IDisposable" /> interface are disposed when the design surface manager is disposed. The <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> class provides the <see cref="T:System.ComponentModel.Design.IDesignerEventService" /> interface as the default service. <see cref="T:System.ComponentModel.Design.IDesignerEventService" /> provides a global eventing mechanism for designer events. With this mechanism, an application is informed when a designer becomes active. The service provides a collection of designers and a single place where global objects, such as the Properties window, can monitor selection change events.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Manages a collection of <see cref="T:System.ComponentModel.Design.DesignSurface" /> objects.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -28,8 +36,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> class.</para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -43,8 +54,11 @@ </Parameters> <Docs> <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="ActiveDesignSurface"> @@ -57,9 +71,15 @@ <ReturnType>System.ComponentModel.Design.DesignSurface</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.DesignSurfaceManager.ActiveDesignSurface" /> property should be set by the designer's user interface whenever a designer becomes the active window. The default implementation of this property works with the default implementation of the <see cref="T:System.ComponentModel.Design.IDesignerEventService" /> interface to notify interested parties that a new designer is now active. If you provide your own implementation of <see cref="T:System.ComponentModel.Design.IDesignerEventService" />, you should override this property to notify your service appropriately. This property can be set to null, indicating that no designer is active.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the active designer.</para> + </summary> </Docs> </Member> <Member MemberName="ActiveDesignSurfaceChanged"> @@ -72,8 +92,11 @@ <ReturnType>System.ComponentModel.Design.ActiveDesignSurfaceChangedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the currently active designer changes.</para> + </summary> </Docs> </Member> <Member MemberName="CreateDesignSurface"> @@ -87,9 +110,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of a design surface.</para> + </summary> </Docs> </Member> <Member MemberName="CreateDesignSurface"> @@ -105,10 +131,18 @@ <Parameter Name="parentProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="parentProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If you want to conveniently add additional per-designer services, use the <paramref name="parentProvider" /> parameter to provide a service provider for this design surface. The <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.CreateDesignSurface(System.IServiceProvider)" /> method creates a merged service provider that can satisfy service requests from both the given service provider as well as the <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> itself. The <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.CreateDesignSurface(System.IServiceProvider)" /> method then passes this service provider into the <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.CreateDesignSurfaceCore(System.IServiceProvider)" /> method.</para> + <para>After <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.CreateDesignSurfaceCore(System.IServiceProvider)" /> returns the design surface, the <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.CreateDesignSurface(System.IServiceProvider)" /> method tries to obtain the <see cref="T:System.ComponentModel.Design.IDesignerEventService" />. If it is present, and if it is the instance of the service that <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> provided by default, the <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.CreateDesignSurface(System.IServiceProvider)" /> method raises the <see cref="E:System.ComponentModel.Design.IDesignerEventService.DesignerCreated" /> event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of a design surface.</para> + </summary> + <param name="parentProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A parent service provider. A new merged service provider will be created that will first ask this provider for a service, and then delegate any failures to the design surface manager object. This merged provider will be passed into the <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.CreateDesignSurfaceCore(System.IServiceProvider)" /> method.</param> </Docs> </Member> <Member MemberName="CreateDesignSurfaceCore"> @@ -124,10 +158,17 @@ <Parameter Name="parentProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="parentProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.CreateDesignSurfaceCore(System.IServiceProvider)" /> method is called by both <see cref="Overload:System.ComponentModel.Design.DesignSurfaceManager.CreateDesignSurface" /> methods. It is the implementation that actually creates the design surface. The default implementation just returns a new <see cref="T:System.ComponentModel.Design.DesignSurface" />. You may override this method to provide a custom object that derives from the <see cref="T:System.ComponentModel.Design.DesignSurface" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implementation that creates the design surface.</para> + </summary> + <param name="parentProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider to pass to the design surface. This is either an instance of <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> or an object that implements <see cref="T:System.IServiceProvider" />, and represents a merge between the service provider of the <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> class and an externally passed provider.</param> </Docs> </Member> <Member MemberName="DesignSurfaceCreated"> @@ -140,8 +181,11 @@ <ReturnType>System.ComponentModel.Design.DesignSurfaceEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a designer is created.</para> + </summary> </Docs> </Member> <Member MemberName="DesignSurfaceDisposed"> @@ -154,8 +198,11 @@ <ReturnType>System.ComponentModel.Design.DesignSurfaceEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a designer is disposed.</para> + </summary> </Docs> </Member> <Member MemberName="DesignSurfaces"> @@ -168,9 +215,15 @@ <ReturnType>System.ComponentModel.Design.DesignSurfaceCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.DesignSurfaceManager.DesignSurfaces" /> property is implemented directly on top of <see cref="T:System.ComponentModel.Design.IDesignerEventService" />, so if you provide your own implementation of that service, this property uses your implementation.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of design surfaces.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -184,8 +237,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The public <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.Dispose" /> method follows the standard <see cref="T:System.IDisposable" /> pattern. Calling this method destroys the design surface manager. It also disposes the service container, which causes all services that implement <see cref="T:System.IDisposable" /> to also be disposed. The protected version of this method is virtual and follows the normal <see cref="T:System.IDisposable" /> pattern. </para> + <block subset="none" type="note"> + <para>Because <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> does not have any native code to clean up, it does not have a finalizer that calls <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.Dispose(System.Boolean)" />. If you need to call <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.Dispose(System.Boolean)" />, you must add a finalizer yourself.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the resources used by the <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" />.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -201,9 +263,21 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The public <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.Dispose" /> method follows the standard <see cref="T:System.IDisposable" /> pattern. Calling this method destroys the design surface manager. It also disposes the service container, which causes all services that implement <see cref="T:System.IDisposable" /> to also be disposed. The protected version of this method is virtual and follows the normal <see cref="T:System.IDisposable" /> pattern. </para> + <block subset="none" type="note"> + <para>Because <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> does not have any native code to clean up, it does not have a finalizer that calls <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.Dispose(System.Boolean)" />. If you need to call <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.Dispose(System.Boolean)" />, you must add a finalizer yourself.</para> + </block> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Design.DesignSurfaceManager" /> and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param> </Docs> </Member> <Member MemberName="GetService"> @@ -220,9 +294,15 @@ </Parameters> <Docs> <param name="service">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignSurfaceManager.GetService(System.Type)" /> method forwards to any service provider that was given to the design surface manager at construction time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a service in the design surface manager’s service container.</para> + </summary> </Docs> </Member> <Member MemberName="SelectionChanged"> @@ -235,8 +315,14 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This event is raised when the active designer's selection of component set changes. This is mapped through the <see cref="T:System.ComponentModel.Design.IDesignerEventService" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the global selection changes.</para> + </summary> </Docs> </Member> <Member MemberName="ServiceContainer"> @@ -249,10 +335,13 @@ <ReturnType>System.ComponentModel.Design.ServiceContainer</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design surface manager's <see cref="P:System.ComponentModel.Design.DesignSurfaceManager.ServiceContainer" />.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionHeaderItem.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionHeaderItem.xml index 968b1888102..fde7665a2a4 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionHeaderItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionHeaderItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionHeaderItem" FullName="System.ComponentModel.Design.DesignerActionHeaderItem"> <TypeSignature Language="C#" Value="public sealed class DesignerActionHeaderItem : System.ComponentModel.Design.DesignerActionTextItem" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Like the <see cref="T:System.ComponentModel.Design.DesignerActionTextItem" /> base class, <see cref="T:System.ComponentModel.Design.DesignerActionHeaderItem" /> represents individual static text items in a smart tag panel. However, <see cref="T:System.ComponentModel.Design.DesignerActionHeaderItem" /> entries are displayed using bold text. Typically, a header item is used to create a heading for a group of items in a panel. Clicking on a header item causes no action.</para> + <para>Individual panel items are associated together to form a panel by calling the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method of the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a static header item on a smart tag panel. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +31,16 @@ <Parameter Name="displayName" Type="System.String" /> </Parameters> <Docs> - <param name="displayName">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor sets both the <see cref="P:System.ComponentModel.Design.DesignerActionItem.DisplayName" /> and the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> properties to the value of the <paramref name="displayName" /> parameter and sets the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> property to null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionHeaderItem" /> class using the provided name string.</para> + </summary> + <param name="displayName"> + <attribution license="cc4" from="Microsoft" modified="false" />The text to be displayed in the header.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -39,11 +54,19 @@ <Parameter Name="category" Type="System.String" /> </Parameters> <Docs> - <param name="displayName">To be added.</param> - <param name="category">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> property to null. The <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> property is case-sensitive.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionHeaderItem" /> class using the provided name and category strings.</para> + </summary> + <param name="displayName"> + <attribution license="cc4" from="Microsoft" modified="false" />The text to be displayed in the header.</param> + <param name="category"> + <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive <see cref="T:System.String" /> that defines the groupings of panel entries.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionItem.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionItem.xml index 25820cd87f5..24e1c612655 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionItem" FullName="System.ComponentModel.Design.DesignerActionItem"> <TypeSignature Language="C#" Value="public abstract class DesignerActionItem" /> <AssemblyInfo> @@ -9,8 +10,18 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> class serves as an abstract base for classes that represent individual panel items in a smart tag panel, which represents a menu-like user interface (UI) for smart tags. The dnprdnshort supplies derived classes that represent the different common entries in a smart tag panel, including plain text, header text, properties and methods of the associated <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class, and designer verbs. </para> + <para>Typically, your DesignerAction feature is defined in a programmer-supplied class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />, which contains a <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method that groups individual panel items together to form the smart tag panel. The <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> and <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> types are associated with members of the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />, and <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> objects are activated when their associated panel entry is selected by the user.</para> + <block subset="none" type="note"> + <para>Forms and dialog boxes can be displayed by members of the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />. By default, the parent of these windows will be the container window for the smart tag panel. Explicitly parenting these child windows to another service or window may cause items to display improperly.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides the base class for types that represent a panel item on a smart tag panel.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,11 +36,21 @@ <Parameter Name="description" Type="System.String" /> </Parameters> <Docs> - <param name="displayName">To be added.</param> - <param name="category">To be added.</param> - <param name="description">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Because <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> is an abstract class, the <see cref="M:System.ComponentModel.Design.DesignerActionItem.#ctor(System.String,System.String,System.String)" /> constructor is intended to be called from derived classes only.</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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> class.</para> + </summary> + <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" /> that defines the groupings of panel entries.</param> + <param name="description"> + <attribution license="cc4" from="Microsoft" modified="false" />Supplemental text for this item, potentially used in ToolTips or the status bar.</param> </Docs> </Member> <Member MemberName="AllowAssociate"> @@ -42,9 +63,85 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Because multiple <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects may be combined to form a single smart tag panel, the <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> property indicates whether the current item can be rearranged by category.</para> + <para>The <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> property is used in conjunction with the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.RelatedComponent" /> property on the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> and <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> types.</para> + <para>For example, ASP.NET uses a data-bound control like <see cref="T:System.Web.UI.WebControls.GridView" /> to connect to a data source control like <see cref="T:System.Web.UI.WebControls.SqlDataSource" />. Both have a <see cref="T:System.ComponentModel.Design.DesignerActionList" /> with its own set of <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects. The <see cref="T:System.Web.UI.WebControls.GridView" /> control has items like <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSourceID" />, Edit Fields, and AutoFormat. The <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> class has Configure and Refresh Items, which have <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> set to true.</para> + <para>The <see cref="T:System.Web.UI.WebControls.GridView" /> control's <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSourceID" /> item has a related component, which is the <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> object. All the <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> object's items that have <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> set to true are automatically included in the <see cref="T:System.Web.UI.WebControls.GridView" /> control's action list. The following table shows how the two lists are merged in the <see cref="T:System.Web.UI.WebControls.GridView" /> control's designer action list.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>GridView items</para> + </term> + <description> + <para>SqlDataSource items</para> + </description> + </item> + </listheader> + <item> + <term> + <list type="bullet"> + <item> + <para>DataSourceID (related component = SqlDataSource)</para> + </item> + <item> + <para>Edit Fields</para> + </item> + <item> + <para>AutoFormat</para> + </item> + </list> + </term> + <description> + <list type="bullet"> + <item> + <para>Configure (AllowAssociate = true)</para> + </item> + <item> + <para>Refresh (AllowAssociate = true)</para> + </item> + </list> + </description> + </item> + </list> + <list type="table"> + <listheader> + <item> + <term> + <para>Merged GridView control's smart tasks panel</para> + </term> + </item> + </listheader> + <item> + <term> + <list type="bullet"> + <item> + <para>DataSourceID </para> + </item> + <item> + <para>Configure </para> + </item> + <item> + <para>Refresh </para> + </item> + <item> + <para>Edit Fields</para> + </item> + <item> + <para>AutoFormat</para> + </item> + </list> + </term> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value indicating whether to allow this item to be placed into a group of items that have the same <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> property value.</para> + </summary> </Docs> </Member> <Member MemberName="Category"> @@ -57,9 +154,16 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Item categories are defined by their names, which are case-sensitive.</para> + <para>For more information about how items are grouped by category, see the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the group name for an item.</para> + </summary> </Docs> </Member> <Member MemberName="Description"> @@ -72,9 +176,16 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> property is used whenever a plain text description of the item is required (for example, in ToolTips and the status bar).</para> + <para>The value of this property is set in the constructor for this class. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the supplemental text for the item.</para> + </summary> </Docs> </Member> <Member MemberName="DisplayName"> @@ -87,9 +198,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The value of the <see cref="P:System.ComponentModel.Design.DesignerActionItem.DisplayName" /> property is set in the constructor for this class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the text for this item.</para> + </summary> </Docs> </Member> <Member MemberName="Properties"> @@ -102,10 +219,17 @@ <ReturnType>System.Collections.IDictionary</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.DesignerActionItem.Properties" /> property allows the programmer to store arbitrary data within an item. The standard properties for this class, such as <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> and <see cref="P:System.ComponentModel.Design.DesignerActionItem.DisplayName" />, are not stored in this collection.</para> + <para>The type of this property is actually <see cref="T:System.Collections.Specialized.HybridDictionary" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a reference to a collection that can be used to store programmer-defined key/value pairs.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionItemCollection.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionItemCollection.xml index 2ee94958924..ce74b942a15 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionItemCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionItemCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionItemCollection" FullName="System.ComponentModel.Design.DesignerActionItemCollection"> <TypeSignature Language="C#" Value="public class DesignerActionItemCollection : System.Collections.CollectionBase" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a collection of <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionItemCollection" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Add"> @@ -38,10 +45,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionItem" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the supplied <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> to the current collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> to add.</param> </Docs> </Member> <Member MemberName="Contains"> @@ -57,10 +68,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionItem" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the <see cref="T:System.ComponentModel.Design.DesignerActionItemCollection" /> contains a specific element.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> to locate in the <see cref="T:System.ComponentModel.Design.DesignerActionItemCollection" />.</param> </Docs> </Member> <Member MemberName="CopyTo"> @@ -77,10 +92,15 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the elements of the current collection into the supplied array, starting at the specified array index.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> array that is the destination of the elements copied from the current collection. The array must have zero-based indexing.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param> </Docs> </Member> <Member MemberName="IndexOf"> @@ -96,10 +116,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionItem" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines the index of a specific item in the collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> to locate in the collection.</param> </Docs> </Member> <Member MemberName="Insert"> @@ -116,10 +140,15 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionItem" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts an element into the <see cref="T:System.ComponentModel.Design.DesignerActionItemCollection" /> at the specified index.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which <paramref name="value" /> should be inserted.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> to insert.</param> </Docs> </Member> <Member MemberName="Item"> @@ -154,10 +183,14 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionItem" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the first occurrence of a specific object from the <see cref="T:System.ComponentModel.Design.DesignerActionItemCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> to remove from the <see cref="T:System.ComponentModel.Design.DesignerActionItemCollection" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionList.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionList.xml index 9417fc8f96a..3d923c64317 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionList.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionList.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionList" FullName="System.ComponentModel.Design.DesignerActionList"> <TypeSignature Language="C#" Value="public class DesignerActionList" /> <AssemblyInfo> @@ -9,8 +10,22 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The DesignerAction feature enables components and controls to display context-sensitive information and commands. The DesignerAction feature can be thought of as a replacement for designer verbs, because a <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> can be displayed in the smart tag panel and also in the shortcut menu associated with a component or control. The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class represents the main point of interaction for developers who want to add smart tag support to their custom components and controls.</para> + <para> + <see cref="T:System.ComponentModel.Design.DesignerActionList" /> is the base class, derived from by component developers in order to populate a smart tag panel. A smart tag panel represents the menu-like user interface (UI) for smart tags. </para> + <para>This derived class may implement the virtual <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method to return a collection of objects derived from <see cref="T:System.ComponentModel.Design.DesignerActionItem" />. These objects represent the smart tag panel items. Each item is displayed in the panel according to its type. For example, a <see cref="T:System.ComponentModel.Design.DesignerActionTextItem" /> is displayed as a static text label. Active panel items, represented by the <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> and <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> types, have a corresponding publicly accessible property or method, respectively, that implements the functionality for that item.</para> + <para>For more information about how to add items to the smart tag panel, see the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method.</para> + <block subset="none" type="note"> + <para>Forms and dialog boxes can be displayed by members of the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />. By default, the parent of these windows will be the container window for the smart tag panel. Explicitly parenting these child windows to another service or window may cause smart tags to display improperly.</para> + <para>Smart-tag panels do not support scrolling or paging, so be careful not to populate your panels with many smart-tag items. Too many items may result in the smart-tag panel extending beyond the screen boundary.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides the base class for types that define a list of items used to create a smart tag panel.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +38,16 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionList.AutoShow" /> property to false.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />A component related to the <see cref="T:System.ComponentModel.Design.DesignerActionList" />.</param> </Docs> </Member> <Member MemberName="AutoShow"> @@ -38,9 +60,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the property value is set to true, the component with which this <see cref="T:System.ComponentModel.Design.DesignerActionList" /> is associated will automatically expand and display the smart tag panel when the component is created. </para> + <para>You can opt out of this behavior by setting the <see cref="P:System.Windows.Forms.Design.DesignerOptions.ObjectBoundSmartTagAutoShow" /> property to false.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value indicating whether the smart tag panel should automatically be displayed when it is created.</para> + </summary> </Docs> </Member> <Member MemberName="Component"> @@ -53,9 +82,12 @@ <ReturnType>System.ComponentModel.IComponent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the component related to <see cref="T:System.ComponentModel.Design.DesignerActionList" />.</para> + </summary> </Docs> </Member> <Member MemberName="GetService"> @@ -71,10 +103,14 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an object that represents a service provided by the component associated with the <see cref="T:System.ComponentModel.Design.DesignerActionList" />.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provided by the <see cref="T:System.ComponentModel.Component" />.</param> </Docs> </Member> <Member MemberName="GetSortedActionItems"> @@ -88,10 +124,79 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The virtual <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method is implemented to return, in the expected display order, a collection of objects derived from the <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> class. These items can be of the following specific types.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Type</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.DesignerActionHeaderItem" /> </para> + </term> + <description> + <para>The group label, displayed in bold.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.DesignerActionTextItem" /> </para> + </term> + <description> + <para>A label, displayed in a plain font.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> </para> + </term> + <description> + <para>A panel item associated with a property. May also display a check mark or property editor associated with the underlying property.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> </para> + </term> + <description> + <para>A panel item displayed as a hyperlink and associated with a method.</para> + </description> + </item> + </list> + <para>For every <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> and <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" />, a corresponding method or property must be added to the programmer-supplied class derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class. Each method and property item is displayed as an active entry; interacting with it through the user interface (UI) invokes the corresponding method or property, respectively.</para> + <para>Property items have a special panel-item interface that enables display and manipulation of their corresponding property values. For more information, see the <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class.</para> + <para>The order of the items in the returned array reflects the order that they will appear in the panel. The items are grouped according to the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> property, using the following rules:</para> + <list type="bullet"> + <item> + <para>The category of the first item encountered signifies the start of the first group. That group continues as long as each succeeding item is of the same category. When an item of a different, new category is encountered, a new group is created and the item is placed in it.</para> + </item> + <item> + <para>If an item has a type different than the current group, but that category has already been used, the item is placed in the matching existing category.</para> + </item> + <item> + <para>If an item does not have a category, it is placed in a miscellaneous group at the end of the panel. This group also contains items whose <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> property is set to false.</para> + </item> + </list> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method is called when the panel is first created. You must call the <see cref="M:System.ComponentModel.Design.DesignerActionUIService.Refresh(System.ComponentModel.IComponent)" /> method to update the list of items displayed in the panel.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the collection of <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects contained in the list.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListCollection.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListCollection.xml index e9c73c56a8e..fb29221f7be 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionListCollection" FullName="System.ComponentModel.Design.DesignerActionListCollection"> <TypeSignature Language="C#" Value="public class DesignerActionListCollection : System.Collections.CollectionBase" /> <AssemblyInfo> @@ -14,8 +15,45 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> class represents the aggregation of all the items in a smart tag panel. The <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> class contains zero or more <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects. Each of these lists contains zero or more objects that represent the actual items in the panel and are derived from the <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> class.</para> + <para>The following table shows the two techniques for supplying a <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> to populate the panel with items for components, including custom controls.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Technique</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para>Pull model</para> + </term> + <description> + <para>The designer for the component class, which is derived from the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class, supplies this collection through the <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" /> property. The designer infrastructure reads this property when it must display the panel.</para> + </description> + </item> + <item> + <term> + <para>Push model</para> + </term> + <description> + <para>A <see cref="T:System.ComponentModel.Design.DesignerActionList" /> or <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> is supplied as a parameter in a call to the <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Add" /> method of the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> associated with the component.</para> + </description> + </item> + </list> + <para>The designer infrastructure constructs a panel by creating a smart tag panel, whose constructor takes two parameters of type <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" />. The collections of lists, which contain the pulled and pushed items, are merged into one panel.</para> + <para>Because it derives from the <see cref="T:System.Collections.CollectionBase" /> class, <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> uses an internal <see cref="T:System.Collections.ArrayList" /> to store its collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -26,8 +64,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionListCollection.#ctor" /> constructor creates an empty collection, containing zero <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> class with default settings.</para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -40,9 +84,16 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionList[]" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionListCollection.#ctor(System.ComponentModel.Design.DesignerActionList[])" /> constructor creates a collection that contains the supplied <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> class with the specified panel items.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The array of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects to populate the collection.</param> </Docs> </Member> <Member MemberName="Add"> @@ -58,10 +109,17 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionList" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The new element is added to the end of the internal list.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the supplied <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to the current collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to add.</param> </Docs> </Member> <Member MemberName="AddRange"> @@ -77,9 +135,17 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionList[]" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The new elements are added to the end of the internal list.</para> + <para>After validating the <paramref name="value" /> parameter, the <see cref="M:System.ComponentModel.Design.DesignerActionListCollection.AddRange(System.ComponentModel.Design.DesignerActionList[])" /> method makes a series of calls to the <see cref="M:System.ComponentModel.Design.DesignerActionListCollection.Add(System.ComponentModel.Design.DesignerActionList)" /> method to individually add each element.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the elements of the supplied <see cref="T:System.ComponentModel.Design.DesignerActionList" /> array to the end of the current collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The array of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects to add.</param> </Docs> </Member> <Member MemberName="AddRange"> @@ -95,9 +161,17 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionListCollection" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The new elements are added to the end of the internal list.</para> + <para>After validating the <paramref name="value" /> parameter, the <see cref="M:System.ComponentModel.Design.DesignerActionListCollection.AddRange(System.ComponentModel.Design.DesignerActionListCollection)" />method makes a series of calls to the <see cref="M:System.ComponentModel.Design.DesignerActionListCollection.Add(System.ComponentModel.Design.DesignerActionList)" /> method to individually add each element.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the elements of the supplied <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> to the end of the current collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> to add.</param> </Docs> </Member> <Member MemberName="Contains"> @@ -113,10 +187,17 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionList" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A match is determined by value, not identity, comparison.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the collection contains a specific value.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to search for.</param> </Docs> </Member> <Member MemberName="CopyTo"> @@ -133,10 +214,18 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="M:System.ComponentModel.Design.DesignerActionListCollection.CopyTo(System.ComponentModel.Design.DesignerActionList[],System.Int32)" /> method throws an exception while copying, the state of the destination array is undefined. For example, if an <see cref="T:System.ArgumentException" /> or <see cref="T:System.InvalidCastException" /> occurs, the destination array may be left in a partially filled state. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the elements of the current collection into the supplied array, starting at the specified array index.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional array of type <see cref="T:System.ComponentModel.Design.DesignerActionList" /> that is the destination of the elements copied from the current collection. The array must have zero-based indexing.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param> </Docs> </Member> <Member MemberName="IndexOf"> @@ -152,10 +241,17 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionList" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Internally, the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> class uses a <see cref="T:System.Collections.ArrayList" /> to contain its collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines the index of a specific item in the collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to locate in the collection.</param> </Docs> </Member> <Member MemberName="Insert"> @@ -172,10 +268,19 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionList" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <paramref name="index" /> parameter is equal to the value of the <see cref="P:System.Collections.CollectionBase.Count" /> property, the new element is added to the end of the collection.</para> + <para>Internally, the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> class uses a <see cref="T:System.Collections.ArrayList" /> to contain its collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects. Because lists maintain contiguous elements, the elements that follow the insertion point move down to accommodate the new element. This rearrangement changes the index of the elements after the insertion point.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts the supplied <see cref="T:System.ComponentModel.Design.DesignerActionList" /> into the collection at the specified position.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which <paramref name="value" /> should be inserted.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to insert into the collection.</param> </Docs> </Member> <Member MemberName="Item"> @@ -226,10 +331,15 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Performs additional custom processes before inserting a new element into the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> instance.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which to insert <paramref name="value" />.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The new value of the element at <paramref name="index" />.</param> </Docs> </Member> <Member MemberName="OnRemove"> @@ -246,10 +356,15 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Performs additional custom processes when removing an element from the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> instance.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which <paramref name="value" /> can be found.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The value of the element to remove from <paramref name="index" />.</param> </Docs> </Member> <Member MemberName="OnSet"> @@ -267,11 +382,17 @@ <Parameter Name="newValue" Type="System.Object" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="oldValue">To be added.</param> - <param name="newValue">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Performs additional custom processes before setting a value in the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> instance.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which <paramref name="oldValue" /> can be found.</param> + <param name="oldValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The value to replace with <paramref name="newValue" />.</param> + <param name="newValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The new value of the element at <paramref name="index" />.</param> </Docs> </Member> <Member MemberName="OnValidate"> @@ -287,9 +408,13 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Performs additional custom processes when validating a value.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to validate.</param> </Docs> </Member> <Member MemberName="Remove"> @@ -305,10 +430,17 @@ <Parameter Name="value" Type="System.ComponentModel.Design.DesignerActionList" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Internally, the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> class uses a <see cref="T:System.Collections.ArrayList" /> to contain its collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects. Since lists maintain contiguous elements, the elements that follow the removal point move up to occupy the vacated spot. This rearrangement changes the index of the elements after the removal point.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the first occurrence of a specific <see cref="T:System.ComponentModel.Design.DesignerActionList" /> from the collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to remove from the current collection.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedEventArgs.xml index c7e6b6cb787..e921e564e4d 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionListsChangedEventArgs" FullName="System.ComponentModel.Design.DesignerActionListsChangedEventArgs"> <TypeSignature Language="C#" Value="public class DesignerActionListsChangedEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event occurs when a <see cref="T:System.ComponentModel.Design.DesignerActionList" /> is added or removed from a managed collection of such lists. This event is not raised when an individual list element changes its value.</para> + <para>The <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event is generated by the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> class when its <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Remove" />, <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Add" />, and <see cref="M:System.ComponentModel.Design.DesignerActionService.Clear" /> methods are executed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,11 +33,20 @@ <Parameter Name="actionLists" Type="System.ComponentModel.Design.DesignerActionListCollection" /> </Parameters> <Docs> - <param name="relatedObject">To be added.</param> - <param name="changeType">To be added.</param> - <param name="actionLists">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event, the <paramref name="relatedObject" /> parameter will always reference the <see cref="T:System.ComponentModel.Component" /> that the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> is associated with.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedEventArgs" /> class.</para> + </summary> + <param name="relatedObject"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that is associated with the collection.</param> + <param name="changeType"> + <attribution license="cc4" from="Microsoft" modified="false" />A value that specifies whether a <see cref="T:System.ComponentModel.Design.DesignerActionList" /> has been added or removed from the collection.</param> + <param name="actionLists"> + <attribution license="cc4" from="Microsoft" modified="false" />The collection of list elements after the action has been applied.</param> </Docs> </Member> <Member MemberName="ActionLists"> @@ -42,9 +59,15 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The retrieved <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> represents the state of the collection after the event, which involved adding or removing an element, has been applied.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects associated with this event.</para> + </summary> </Docs> </Member> <Member MemberName="ChangeType"> @@ -57,9 +80,15 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListsChangedType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Altering the contents of an existing <see cref="T:System.ComponentModel.Design.DesignerActionList" /> in the collection will not raise a <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a flag indicating whether an element has been added or removed from the collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects.</para> + </summary> </Docs> </Member> <Member MemberName="RelatedObject"> @@ -72,10 +101,17 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.DesignerActionListsChangedEventArgs.RelatedObject" /> property enables the programmer to associate an object to an instance of the <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedEventArgs" /> class. </para> + <para>For the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event, the <see cref="P:System.ComponentModel.Design.DesignerActionListsChangedEventArgs.RelatedObject" /> property should always reference the <see cref="T:System.ComponentModel.Component" /> that the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> is associated with.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the object that that is associated with the collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedEventHandler.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedEventHandler.xml index 8f2797dd1f3..72d0f6dc028 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedEventHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionListsChangedEventHandler" FullName="System.ComponentModel.Design.DesignerActionListsChangedEventHandler"> <TypeSignature Language="C#" Value="public delegate void DesignerActionListsChangedEventHandler(object sender, DesignerActionListsChangedEventArgs e);" /> <AssemblyInfo> @@ -22,7 +23,22 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The event model in the dnprdnshort is based on having an event delegate that connects an event with its handler. To raise a <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event, two elements are needed:</para> + <list type="bullet"> + <item> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedEventArgs" /> class, derived from <see cref="T:System.EventArgs" />, which holds the event data.</para> + </item> + <item> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedEventHandler" /> delegate, which points to a method that provides the response to the event.</para> + </item> + </list> + <para>When you create a <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedEventHandler" /> delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event of a <see cref="T:System.ComponentModel.Design.DesignerActionService" />. This class cannot be inherited.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedType.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedType.xml index 16fdd1a25b4..2604b9e9482 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedType.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionListsChangedType.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionListsChangedType" FullName="System.ComponentModel.Design.DesignerActionListsChangedType"> <TypeSignature Language="C#" Value="public enum DesignerActionListsChangedType" /> <AssemblyInfo> @@ -13,8 +14,17 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedType" /> enumeration indicates that an element has been added or removed from a managed collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects. This enumeration is used in the <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedEventArgs" /> class, which is associated with the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event.</para> + <block subset="none" type="note"> + <para>Although the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> class is a collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects, it does not directly raise events. Instead, the owning <see cref="T:System.ComponentModel.Design.DesignerActionService" /> raises <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> events.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the type of change occurring in a collection of <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects.</para> + </summary> </Docs> <Members> <Member MemberName="ActionListsAdded"> @@ -27,7 +37,10 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListsChangedType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>One or more <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects have been added to the collection.</para> + </summary> </Docs> </Member> <Member MemberName="ActionListsRemoved"> @@ -40,8 +53,11 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListsChangedType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>One or more <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects have been removed from the collection.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionMethodItem.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionMethodItem.xml index 67a65e0c36f..5b7cea86d38 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionMethodItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionMethodItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionMethodItem" FullName="System.ComponentModel.Design.DesignerActionMethodItem"> <TypeSignature Language="C#" Value="public class DesignerActionMethodItem : System.ComponentModel.Design.DesignerActionItem" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> class represents individual items in a smart tag panel. An item of this type is displayed as an active user interface element, such as a hyperlink, that invokes a programmer-supplied method in a class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />. The association between the item and the method is maintained through the value of the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.MemberName" /> property. The method that this item invokes must neither take parameters nor return a value.</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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a smart tag panel item that is associated with a method in a class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,11 +33,20 @@ <Parameter Name="displayName" Type="System.String" /> </Parameters> <Docs> - <param name="actionList">To be added.</param> - <param name="memberName">To be added.</param> - <param name="displayName">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionMethodItem.#ctor(System.ComponentModel.Design.DesignerActionList,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, and the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.IncludeAsDesignerVerb" /> property to false.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> class, with the specified method and display names.</para> + </summary> + <param name="actionList"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> that contains the method this item is associated with.</param> + <param name="memberName"> + <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the method in the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to invoke through the 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"> @@ -45,12 +62,23 @@ <Parameter Name="includeAsDesignerVerb" Type="System.Boolean" /> </Parameters> <Docs> - <param name="actionList">To be added.</param> - <param name="memberName">To be added.</param> - <param name="displayName">To be added.</param> - <param name="includeAsDesignerVerb">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <paramref name="includeAsDesignerVerb" /> parameter is set to true, then this item is also considered a <see cref="T:System.ComponentModel.Design.DesignerVerb" />; therefore, it will be added to the component's design-time shortcut menu. In vsprvs, a command will also be added to the <ui>Attributes</ui> pane of the Properties window. A list of designer verbs can be accessed through the designer's <see cref="P:System.ComponentModel.Design.ComponentDesigner.Verbs" /> collection property.</para> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionMethodItem.#ctor(System.ComponentModel.Design.DesignerActionList,System.String,System.String,System.Boolean)" /> constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> and <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> properties to null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> class, with the specified method and display names, and a flag that indicates whether the item should appear in other user interface contexts.</para> + </summary> + <param name="actionList"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> that contains the method this item is associated with.</param> + <param name="memberName"> + <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the method in the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to invoke through the panel item.</param> + <param name="displayName"> + <attribution license="cc4" from="Microsoft" modified="false" />The panel text for this item.</param> + <param name="includeAsDesignerVerb"> + <attribution license="cc4" from="Microsoft" modified="false" />A flag that specifies whether to also treat the associated method as a designer verb.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -66,12 +94,23 @@ <Parameter Name="category" Type="System.String" /> </Parameters> <Docs> - <param name="actionList">To be added.</param> - <param name="memberName">To be added.</param> - <param name="displayName">To be added.</param> - <param name="category">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionMethodItem.#ctor(System.ComponentModel.Design.DesignerActionList,System.String,System.String,System.String)" /> constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> property to null and the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.IncludeAsDesignerVerb" /> property to false.</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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> class, with the specified method, display, and category names.</para> + </summary> + <param name="actionList"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> that contains the method this item is associated with.</param> + <param name="memberName"> + <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the method in the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to invoke through the 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"> @@ -88,13 +127,26 @@ <Parameter Name="includeAsDesignerVerb" Type="System.Boolean" /> </Parameters> <Docs> - <param name="actionList">To be added.</param> - <param name="memberName">To be added.</param> - <param name="displayName">To be added.</param> - <param name="category">To be added.</param> - <param name="includeAsDesignerVerb">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <paramref name="includeAsDesignerVerb" /> parameter is set to true, then the item is also considered a <see cref="T:System.ComponentModel.Design.DesignerVerb" />; therefore, it will be added to the component's design-time shortcut menu. A list of designer verbs can be accessed through the designer's <see cref="P:System.ComponentModel.Design.ComponentDesigner.Verbs" /> collection property.</para> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionMethodItem.#ctor(System.ComponentModel.Design.DesignerActionList,System.String,System.String,System.String,System.Boolean)" /> constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> property to null.</para> + <para>For more information on 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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> class, with the specified method, display, and category names, and a flag that indicates whether the item should appear in other user interface contexts.</para> + </summary> + <param name="actionList"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> that contains the method this item is associated with.</param> + <param name="memberName"> + <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the method in the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to invoke through the 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="includeAsDesignerVerb"> + <attribution license="cc4" from="Microsoft" modified="false" />A flag that specifies whether to also treat the associated method as a designer verb for the associated component.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -111,13 +163,25 @@ <Parameter Name="description" Type="System.String" /> </Parameters> <Docs> - <param name="actionList">To be added.</param> - <param name="memberName">To be added.</param> - <param name="displayName">To be added.</param> - <param name="category">To be added.</param> - <param name="description">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionMethodItem.#ctor(System.ComponentModel.Design.DesignerActionList,System.String,System.String,System.String,System.String)" /> constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.IncludeAsDesignerVerb" /> property to false.</para> + <para>For more information on 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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> class, with the specified method and category names, and display and description text.</para> + </summary> + <param name="actionList"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> that contains the method this item is associated with.</param> + <param name="memberName"> + <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the method in the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to invoke through the 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=".ctor"> @@ -135,14 +199,27 @@ <Parameter Name="includeAsDesignerVerb" Type="System.Boolean" /> </Parameters> <Docs> - <param name="actionList">To be added.</param> - <param name="memberName">To be added.</param> - <param name="displayName">To be added.</param> - <param name="category">To be added.</param> - <param name="description">To be added.</param> - <param name="includeAsDesignerVerb">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <paramref name="includeAsDesignerVerb" /> parameter is set to true, then this item is also considered a <see cref="T:System.ComponentModel.Design.DesignerVerb" />; therefore, it will be added to the component's design-time shortcut menu. A list of designer verbs can be accessed through the designer's <see cref="P:System.ComponentModel.Design.ComponentDesigner.Verbs" /> collection property.</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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> class, with the specified method and category names, display and description text, and a flag that indicates whether the item should appear in other user interface contexts.</para> + </summary> + <param name="actionList"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> that contains the method this item is associated with.</param> + <param name="memberName"> + <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the method in the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to invoke through the 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> + <param name="includeAsDesignerVerb"> + <attribution license="cc4" from="Microsoft" modified="false" />A flag that specifies whether to also treat the associated method as a designer verb for the associated component.</param> </Docs> </Member> <Member MemberName="IncludeAsDesignerVerb"> @@ -155,9 +232,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.IncludeAsDesignerVerb" /> property is set to true, then the item is also considered a <see cref="T:System.ComponentModel.Design.DesignerVerb" />; therefore, it will be added to the component's design-time shortcut menu. A list of designer verbs can be accessed through the designer's <see cref="P:System.ComponentModel.Design.ComponentDesigner.Verbs" /> collection property.</para> + <para>The value of the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.IncludeAsDesignerVerb" /> property is set in the constructor for this class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> should appear in other user interface contexts.</para> + </summary> </Docs> </Member> <Member MemberName="Invoke"> @@ -171,8 +255,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.IncludeAsDesignerVerb" /> property is initialized to true, the associated method can also be invoked through the corresponding designer verb event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Programmatically executes the method associated with the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" />.</para> + </summary> </Docs> </Member> <Member MemberName="MemberName"> @@ -185,9 +275,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.MemberName" /> property specifies which property, in the class derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class, that 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>The bound method should neither take parameters nor return a value.</para> + <para>This property is set in the constructor. It is case-sensitive.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the method that this <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> is associated with.</para> + </summary> </Docs> </Member> <Member MemberName="RelatedComponent"> @@ -200,10 +298,17 @@ <ReturnType>System.ComponentModel.IComponent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.DesignerActionPropertyItem.RelatedComponent" /> property allows another component to lend its smart tag panel items to the current list. For example, a user control might aggregate the items from one of its constituent standard 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 <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> objects to the current panel.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionPropertyItem.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionPropertyItem.xml index 286a115a522..7489ea515f2 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionPropertyItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionPropertyItem.xml @@ -1,3 +1,4 @@ +<?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> @@ -9,8 +10,61 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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"> @@ -24,10 +78,19 @@ <Parameter Name="displayName" Type="System.String" /> </Parameters> <Docs> - <param name="memberName">To be added.</param> - <param name="displayName">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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"> @@ -42,11 +105,22 @@ <Parameter Name="category" Type="System.String" /> </Parameters> <Docs> - <param name="memberName">To be added.</param> - <param name="displayName">To be added.</param> - <param name="category">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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"> @@ -62,12 +136,23 @@ <Parameter Name="description" Type="System.String" /> </Parameters> <Docs> - <param name="memberName">To be added.</param> - <param name="displayName">To be added.</param> - <param name="category">To be added.</param> - <param name="description">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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"> @@ -80,9 +165,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <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"> @@ -95,10 +188,17 @@ <ReturnType>System.ComponentModel.IComponent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <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> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionService.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionService.xml index ea1ad9dfad1..cc3d7df861e 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionService.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionService" FullName="System.ComponentModel.Design.DesignerActionService"> <TypeSignature Language="C#" Value="public class DesignerActionService : IDisposable" /> <AssemblyInfo> @@ -13,8 +14,45 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionService" /> class is responsible for managing the collection of <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects for each instance of a component that exists on a form at design time. This class enables a direct push model of item creation, and is primarily intended for use by design-time tool developers, although it can also be used by component and custom control developers.</para> + <para>Design-time tool developers will need to determine the list of items to display for a component and determine when this list changes. They may also create add-ins that operate in conjunction with smart tag panel objects.</para> + <para>Advanced component developers may need to dynamically control the items associated with a component, thus replacing or supplementing the standard pull model. For example, panel commands can be altered depending on the context of their use and the design-time state of the component.</para> + <block subset="none" type="note"> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionService" /> is actually the driving service behind both the push and pull models; however, in the latter case it operates implicitly.</para> + </block> + <para> + <see cref="T:System.ComponentModel.Design.DesignerActionService" /> provides a straightforward interface for accessing and manipulating the items for each component, including the following methods and events:</para> + <list type="bullet"> + <item> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.Contains(System.ComponentModel.IComponent)" /> method determines whether the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> is currently managing a particular component.</para> + </item> + <item> + <para>The <see cref="Overload:System.ComponentModel.Design.DesignerActionService.GetComponentActions" /> method supports the enumeration of the lists of items.</para> + </item> + <item> + <para>The <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Add" /> method allows adding a <see cref="T:System.ComponentModel.Design.DesignerActionList" /> or <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> to the set of existing items for a component instance. In contrast, the <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Remove" /> method removes one or all of the item lists associated with a component.</para> + <block subset="none" type="note"> + <para>The <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Add" /> method represents the direct push model of associating panel items with a component. In contrast, the pull model relies on overriding the <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" /> property of the designer class for that component. The design environment is responsible for adding these items into the current <see cref="T:System.ComponentModel.Design.DesignerActionService" /> when a component is created on the design surface.</para> + </block> + <block subset="none" type="note"> + <para>The <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Add" />, <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Remove" />, <see cref="M:System.ComponentModel.Design.DesignerActionService.Contains(System.ComponentModel.IComponent)" />, and <see cref="M:System.ComponentModel.Design.DesignerActionService.Clear" /> methods only consider or affect push-model items.</para> + </block> + </item> + <item> + <para>The <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event indicates when the collection of items changes for a component.</para> + </item> + </list> + <para>Because it is often desirable to use some of the same panel items in both the component's design-time shortcut menu and its panel, a large degree of interoperability exists between <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects and designer verbs.</para> + <para>If a component designer does not explicitly specify a <see cref="T:System.ComponentModel.Design.DesignerActionList" /> (that is, it does not contain an overridden <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" /> property), then a list will be created from existing designer verbs. These verbs are specified by the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Verbs" /> property. In this case, an internal verb list class is used to contain the collection of verb item panel entries.</para> + <para>If you want a <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> to be used both as a panel entry and a design-time shortcut menu entry, then you can set the <paramref name="includeAsDesignerVerb" /> parameter in the item's constructor.</para> + <para>Use the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" /> to control the display of your designer's <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Establishes a design-time service that manages the collection of <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects for components.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,9 +65,17 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A service provider is necessary for monitoring selection and component changes. It is expected to support the <see cref="T:System.ComponentModel.Design.IDesignerHost" /> and <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> types. The <see cref="T:System.ComponentModel.Design.DesignerActionService" /> class uses an internal table to manage components and their associated <see cref="T:System.ComponentModel.Design.DesignerActionList" /> smart tags.</para> + <para>Typically, component developers will not need to create an instance of this class; instead, they can acquire an existing instance through a call to the <see cref="M:System.ComponentModel.Component.GetService(System.Type)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> class.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The service provider for the current design-time environment.</param> </Docs> </Member> <Member MemberName="Add"> @@ -46,10 +92,21 @@ <Parameter Name="actionList" Type="System.ComponentModel.Design.DesignerActionList" /> </Parameters> <Docs> - <param name="comp">To be added.</param> - <param name="actionList">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.Add(System.ComponentModel.IComponent,System.ComponentModel.Design.DesignerActionList)" /> method represents the push model of adding smart tag items. The alternate pull model relies on overriding the <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" /> property in the designer for the corresponding component.</para> + <para>When this method is called, the lists to be added are scanned for any <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> with the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.IncludeAsDesignerVerb" /> property set to true. These items are added to the list of designer verbs for this component, through a call to the <see cref="M:System.ComponentModel.Design.MenuCommandService.AddVerb(System.ComponentModel.Design.DesignerVerb)" /> method.</para> + <para>Smart tags are managed on a component instance basis. The managed collection may contain duplicate entries.</para> + <para>This method raises the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a <see cref="T:System.ComponentModel.Design.DesignerActionList" /> to the current collection of managed smart tags.</para> + </summary> + <param name="comp"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to associate the smart tags with.</param> + <param name="actionList"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> that contains the new smart tag items to be added.</param> </Docs> </Member> <Member MemberName="Add"> @@ -66,10 +123,21 @@ <Parameter Name="designerActionListCollection" Type="System.ComponentModel.Design.DesignerActionListCollection" /> </Parameters> <Docs> - <param name="comp">To be added.</param> - <param name="designerActionListCollection">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.Add(System.ComponentModel.IComponent,System.ComponentModel.Design.DesignerActionListCollection)" /> method represents the push model of adding smart tag items. The alternate pull model relies on overriding the <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" /> property in the designer for the corresponding component.</para> + <para>When this method is called, the lists to be added are scanned for any <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> with the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.IncludeAsDesignerVerb" /> property set to true. These items are added to the list of designer verbs for this component, through a call to the <see cref="M:System.ComponentModel.Design.MenuCommandService.AddVerb(System.ComponentModel.Design.DesignerVerb)" /> method.</para> + <para>Smart tags are managed on a component instance basis. The managed collection may contain duplicate entries.</para> + <para>This method raises the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> to the current collection of managed smart tags.</para> + </summary> + <param name="comp"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to associate the smart tags with.</param> + <param name="designerActionListCollection"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> that contains the new smart tag items to be added.</param> </Docs> </Member> <Member MemberName="Clear"> @@ -83,8 +151,18 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.Clear" /> method empties the internal table used to store information about components and their push-model smart tag lists.</para> + <block subset="none" type="note"> + <para>Because this method affects all components managed by the current service, and not just the current component, this method should be used judiciously. Typically, the design-time tool developer uses it when resetting a design surface. Component developers should use one of the <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Remove" /> methods instead to remove individual smart tag items or lists.</para> + </block> + <para>A <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event is raised for each component that was previously managed by the current service.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases all components from management and clears all push-model smart tag lists.</para> + </summary> </Docs> </Member> <Member MemberName="Contains"> @@ -100,10 +178,18 @@ <Parameter Name="comp" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="comp">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.Contains(System.ComponentModel.IComponent)" /> method only recognizes push-model smart tags, which are associated to a component with the <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Add" /> method.</para> + <para>Although there is no structural limitation on the number of concurrent <see cref="T:System.ComponentModel.Design.DesignerActionService" /> instances created by a design-time tool, typically only a single instance of the service is created per design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the current smart tag service manages the action lists for the specified component.</para> + </summary> + <param name="comp"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to search for.</param> </Docs> </Member> <Member MemberName="DesignerActionListsChanged"> @@ -116,8 +202,57 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListsChangedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The following table shows the set of specialized classes associated with the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> 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.DesignerActionListsChangedEventArgs" /> + </para> + </term> + <description> + <para>Adds information specific to smart tag list management. This class is specialized from <see cref="T:System.EventArgs" />.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedEventHandler" /> + </para> + </term> + <description> + <para>Connects the <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedEventArgs" /> with its handler.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.DesignerActionListsChangedType" /> + </para> + </term> + <description> + <para>Denotes whether a list has been added or removed.</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 <see cref="T:System.ComponentModel.Design.DesignerActionList" /> is removed or added for any component.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -131,8 +266,26 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.Dispose" /> method is the implementation of the only method mandated by the <see cref="T:System.IDisposable" /> interface. Call this method when you are finished using the <see cref="T:System.ComponentModel.Design.DesignerActionService" />. It performs two main actions:</para> + <list type="bullet"> + <item> + <para>Removes the current service from the list of available services in the design environment through a call to the <see cref="Overload:System.ComponentModel.Design.IServiceContainer.RemoveService" /> method.</para> + </item> + <item> + <para>Unsubscribes to component change events from the associated <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> interface.</para> + </item> + </list> + <para>Call <see cref="M:System.ComponentModel.Design.DesignerActionService.Dispose" /> when you are finished using the <see cref="T:System.ComponentModel.Design.DesignerActionService" />. The <see cref="M:System.ComponentModel.Design.DesignerActionService.Dispose" /> method leaves the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> in an unusable state. After calling <see cref="M:System.ComponentModel.Design.DesignerActionService.Dispose" />, you must release all references to the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> 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.DesignerActionService.Dispose" /> before you release your last reference to the <see cref="T:System.ComponentModel.Design.DesignerActionService" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> 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.DesignerActionService" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -148,9 +301,26 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.Dispose" /> method is the implementation of the only method mandated by the <see cref="T:System.IDisposable" /> interface. Call this method when you are finished using the <see cref="T:System.ComponentModel.Design.DesignerActionService" />. It performs two main actions:</para> + <list type="bullet"> + <item> + <para>Removes the current service from the list of available services in the design environment through a call to the <see cref="Overload:System.ComponentModel.Design.IServiceContainer.RemoveService" /> method.</para> + </item> + <item> + <para>Unsubscribes to component change events from the associated <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> interface.</para> + </item> + </list> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.ComponentModel.Design.DesignerActionService" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> and optionally releases the managed resources. </para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> </Member> <Member MemberName="GetComponentActions"> @@ -166,10 +336,18 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.GetComponentActions(System.ComponentModel.IComponent)" /> method is equivalent to a call to the <see cref="M:System.ComponentModel.Design.DesignerActionService.GetComponentActions(System.ComponentModel.IComponent,System.ComponentModel.Design.ComponentActionsType)" /> method using a <paramref name="type" /> parameter of <see cref="F:System.ComponentModel.Design.ComponentActionsType.All" />. Therefore, the collection returned will contain both the push and pull lists of smart tags.</para> + <para>The returned <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> is the union of item lists added through the <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Add" /> methods and also the lists obtained from the <see cref="T:System.ComponentModel.Design.DesignerCommandSet" /> instance obtained from the component’s site.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the collection of smart tag item lists associated with a component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component that the smart tags are associated with.</param> </Docs> </Member> <Member MemberName="GetComponentActions"> @@ -186,11 +364,59 @@ <Parameter Name="type" Type="System.ComponentModel.Design.ComponentActionsType" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="type">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This version of the overloaded <see cref="Overload:System.ComponentModel.Design.DesignerActionService.GetComponentActions" /> method filters on the <paramref name="type" /> parameter, which can have one of the following values. </para> + <list type="table"> + <listheader> + <item> + <term> + <para>Value</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="F:System.ComponentModel.Design.ComponentActionsType.All" /> </para> + </term> + <description> + <para>All associated smart tags.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="F:System.ComponentModel.Design.ComponentActionsType.Component" /> </para> + </term> + <description> + <para>Pull-model smart tags only.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="F:System.ComponentModel.Design.ComponentActionsType.Service" /> </para> + </term> + <description> + <para>Push-model smart tags only.</para> + </description> + </item> + </list> + <para>If the associated designer for a component does not supply a pull-model smart tag list, then the <see cref="M:System.ComponentModel.Design.DesignerActionService.GetComponentActions(System.ComponentModel.IComponent,System.ComponentModel.Design.ComponentActionsType)" /> method will instead use the designer's design-time shortcut menu items from the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Verbs" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the collection of smart tag item lists of the specified type associated with a component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component that the smart tags are associated with.</param> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.ComponentActionsType" /> to filter the associated smart tags with.</param> </Docs> </Member> <Member MemberName="GetComponentDesignerActions"> @@ -207,10 +433,19 @@ <Parameter Name="actionLists" Type="System.ComponentModel.Design.DesignerActionListCollection" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="actionLists">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.GetComponentDesignerActions(System.ComponentModel.IComponent,System.ComponentModel.Design.DesignerActionListCollection)" /> method is a helper method for the <see cref="Overload:System.ComponentModel.Design.DesignerActionService.GetComponentActions" /> methods. <see cref="M:System.ComponentModel.Design.DesignerActionService.GetComponentDesignerActions(System.ComponentModel.IComponent,System.ComponentModel.Design.DesignerActionListCollection)" /> searches for pull-model smart tags of type <see cref="F:System.ComponentModel.Design.ComponentActionsType.Component" />, and then adds these to the supplied <paramref name="actionLists" /> collection.</para> + <para>If the component's developer does not explicitly supply a collection of smart tags through the <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" /> property of its designer, this method will reuse the design-time shortcut menu entries, which are obtained through the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Verbs" /> property of the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the pull-model smart tags associated with a component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component that the smart tags are associated with.</param> + <param name="actionLists"> + <attribution license="cc4" from="Microsoft" modified="false" />The collection to add the associated smart tags to.</param> </Docs> </Member> <Member MemberName="GetComponentServiceActions"> @@ -227,10 +462,18 @@ <Parameter Name="actionLists" Type="System.ComponentModel.Design.DesignerActionListCollection" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="actionLists">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionService.GetComponentServiceActions(System.ComponentModel.IComponent,System.ComponentModel.Design.DesignerActionListCollection)" /> method is a helper method for the <see cref="Overload:System.ComponentModel.Design.DesignerActionService.GetComponentActions" /> methods. It searches for push-model smart tags of type <see cref="F:System.ComponentModel.Design.ComponentActionsType.Service" />, and then adds these to the supplied <paramref name="actionLists" /> collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the push-model smart tags associated with a component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component that the smart tags are associated with.</param> + <param name="actionLists"> + <attribution license="cc4" from="Microsoft" modified="false" />The collection to add the associated smart tags to.</param> </Docs> </Member> <Member MemberName="Remove"> @@ -246,9 +489,17 @@ <Parameter Name="actionList" Type="System.ComponentModel.Design.DesignerActionList" /> </Parameters> <Docs> - <param name="actionList">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This version of the <see cref="Overload:System.ComponentModel.Design.DesignerActionService.Remove" /> method is typically used by design tool developers, because component developers typically do not know what other components exist in the current design space.</para> + <para>If successful, this method raises the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified smart tag list from all components managed by the current service.</para> + </summary> + <param name="actionList"> + <attribution license="cc4" from="Microsoft" modified="false" />The list of smart tags to be removed.</param> </Docs> </Member> <Member MemberName="Remove"> @@ -264,9 +515,16 @@ <Parameter Name="comp" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="comp">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If successful, the <see cref="M:System.ComponentModel.Design.DesignerActionService.Remove(System.ComponentModel.IComponent)" /> method raises the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes all the smart tag lists associated with the specified component.</para> + </summary> + <param name="comp"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to disassociate the smart tags from.</param> </Docs> </Member> <Member MemberName="Remove"> @@ -283,11 +541,19 @@ <Parameter Name="actionList" Type="System.ComponentModel.Design.DesignerActionList" /> </Parameters> <Docs> - <param name="comp">To be added.</param> - <param name="actionList">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If successful, the <see cref="M:System.ComponentModel.Design.DesignerActionService.Remove(System.ComponentModel.IComponent,System.ComponentModel.Design.DesignerActionList)" /> method raises the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified smart tag list from the specified component.</para> + </summary> + <param name="comp"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to disassociate the smart tags from.</param> + <param name="actionList"> + <attribution license="cc4" from="Microsoft" modified="false" />The smart tag list to remove.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionTextItem.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionTextItem.xml index e30b58ff8a3..eeb228f42f8 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionTextItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionTextItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionTextItem" FullName="System.ComponentModel.Design.DesignerActionTextItem"> <TypeSignature Language="C#" Value="public class DesignerActionTextItem : System.ComponentModel.Design.DesignerActionItem" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionTextItem" /> class represents individual static text items in a smart tag panel. Individual items are associated together to form a panel by returning the group from a call to the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method.</para> + <para>Most commonly, a static text item is used to create an informative label in a panel. Clicking on a static text item causes no action. The derived type <see cref="T:System.ComponentModel.Design.DesignerActionHeaderItem" /> is typically used to create labels to separate categories.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a static text item on a smart tag panel.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,11 +32,20 @@ <Parameter Name="category" Type="System.String" /> </Parameters> <Docs> - <param name="displayName">To be added.</param> - <param name="category">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionTextItem.#ctor(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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionTextItem" /> class.</para> + </summary> + <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 category used to group similar items on the panel.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIService.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIService.xml index 8a8a96364bd..5f8612a9603 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIService.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIService.xml @@ -1,3 +1,4 @@ +<?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> @@ -13,8 +14,23 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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"> @@ -27,8 +43,54 @@ <ReturnType>System.ComponentModel.Design.DesignerActionUIStateChangeEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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"> @@ -42,8 +104,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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"> @@ -59,9 +130,19 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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"> @@ -77,9 +158,16 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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"> @@ -95,10 +183,14 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <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> + <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"> @@ -114,10 +206,20 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <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> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeEventArgs.xml index bd76b7565f5..cf9e36557e4 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionUIStateChangeEventArgs" FullName="System.ComponentModel.Design.DesignerActionUIStateChangeEventArgs"> <TypeSignature Language="C#" Value="public class DesignerActionUIStateChangeEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event occurs when a smart tag panel is displayed or hidden. This event is not generated directly by the panel but rather by the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" /> class when its <see cref="M:System.ComponentModel.Design.DesignerActionUIService.ShowUI(System.ComponentModel.IComponent)" /> and <see cref="M:System.ComponentModel.Design.DesignerActionUIService.HideUI(System.ComponentModel.IComponent)" /> methods are executed. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +31,18 @@ <Parameter Name="changeType" Type="System.ComponentModel.Design.DesignerActionUIStateChangeType" /> </Parameters> <Docs> - <param name="relatedObject">To be added.</param> - <param name="changeType">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For the <see cref="E:System.ComponentModel.Design.DesignerActionService.DesignerActionListsChanged" /> event, the <paramref name="relatedObject" /> parameter always references the <see cref="T:System.ComponentModel.Component" /> that the panel is associated with.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeEventArgs" /> class.</para> + </summary> + <param name="relatedObject"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that is associated with the panel.</param> + <param name="changeType"> + <attribution license="cc4" from="Microsoft" modified="false" />A value that specifies whether the panel is being displayed or hidden.</param> </Docs> </Member> <Member MemberName="ChangeType"> @@ -40,9 +55,15 @@ <ReturnType>System.ComponentModel.Design.DesignerActionUIStateChangeType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the panel is being hidden through a call to the <see cref="M:System.ComponentModel.Design.DesignerActionUIService.HideUI(System.ComponentModel.IComponent)" /> method, this property has a value of <see cref="F:System.ComponentModel.Design.DesignerActionUIStateChangeType.Hide" />. If the panel is being shown through a call to <see cref="M:System.ComponentModel.Design.DesignerActionUIService.ShowUI(System.ComponentModel.IComponent)" />, this property has a value of <see cref="F:System.ComponentModel.Design.DesignerActionUIStateChangeType.Show" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a flag indicating whether the smart tag panel is being displayed or hidden.</para> + </summary> </Docs> </Member> <Member MemberName="RelatedObject"> @@ -55,10 +76,16 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.DesignerActionUIStateChangeEventArgs.RelatedObject" /> property enables the programmer to associate an object to an instance of the <see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeEventArgs" /> class. This object then is available to methods that handle the <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the object that is associated with the smart tag panel.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeEventHandler.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeEventHandler.xml index 1e5006f083f..6c57562a8f7 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeEventHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionUIStateChangeEventHandler" FullName="System.ComponentModel.Design.DesignerActionUIStateChangeEventHandler"> <TypeSignature Language="C#" Value="public delegate void DesignerActionUIStateChangeEventHandler(object sender, DesignerActionUIStateChangeEventArgs e);" /> <AssemblyInfo> @@ -17,7 +18,22 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The event model in the dnprdnshort is based on having an event delegate that connects an event with its handler. To raise a <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event, two elements are needed:</para> + <list type="bullet"> + <item> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeEventArgs" /> class, derived from <see cref="T:System.EventArgs" />, which holds the event data.</para> + </item> + <item> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeEventHandler" /> delegate, which points to a method that provides the response to the event.</para> + </item> + </list> + <para>When you create a <see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeEventHandler" /> delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event of a <see cref="T:System.ComponentModel.Design.DesignerActionUIService" />.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeType.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeType.xml index a615ab18fb3..c971c86eb0c 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeType.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerActionUIStateChangeType.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerActionUIStateChangeType" FullName="System.ComponentModel.Design.DesignerActionUIStateChangeType"> <TypeSignature Language="C#" Value="public enum DesignerActionUIStateChangeType" /> <AssemblyInfo> @@ -8,8 +9,14 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeType" /> enumeration is used in the <see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeEventArgs" /> class and is associated with the <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event, which indicates whether the panel is being displayed or hidden.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the display state of a smart tag panel.</para> + </summary> </Docs> <Members> <Member MemberName="Hide"> @@ -22,7 +29,10 @@ <ReturnType>System.ComponentModel.Design.DesignerActionUIStateChangeType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The smart tag panel is being hidden.</para> + </summary> </Docs> </Member> <Member MemberName="Refresh"> @@ -35,7 +45,10 @@ <ReturnType>System.ComponentModel.Design.DesignerActionUIStateChangeType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The smart tag panel is being refreshed.</para> + </summary> </Docs> </Member> <Member MemberName="Show"> @@ -48,8 +61,11 @@ <ReturnType>System.ComponentModel.Design.DesignerActionUIStateChangeType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The smart tag panel is being displayed.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerCommandSet.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerCommandSet.xml index 8d8b957b728..99570964dc6 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerCommandSet.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DesignerCommandSet.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerCommandSet" FullName="System.ComponentModel.Design.DesignerCommandSet"> <TypeSignature Language="C#" Value="public class DesignerCommandSet" /> <AssemblyInfo> @@ -9,8 +10,58 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class provides the <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" /> and <see cref="P:System.ComponentModel.Design.ComponentDesigner.Verbs" /> properties to query for the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> and <see cref="T:System.ComponentModel.Design.DesignerVerb" /> collections, respectively. However, if a design-time tool author decides not to derive from this class, the <see cref="T:System.ComponentModel.Design.DesignerCommandSet" /> class represents an alternative base class to provide this functionality.</para> + <para>The <see cref="T:System.ComponentModel.Design.DesignerCommandSet" /> class contains only three members, described in the following table.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Public member</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="M:System.ComponentModel.Design.DesignerCommandSet.GetCommands(System.String)" /> + </para> + </term> + <description> + <para>Returns the collection of either the smart tags or designer verbs associated with the designed component. The base implementation returns null.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.ComponentModel.Design.DesignerCommandSet.ActionLists" /> + </para> + </term> + <description> + <para>Gets the collection of all the smart tags associated with the designed component. The base implementation simply calls <see cref="M:System.ComponentModel.Design.DesignerCommandSet.GetCommands(System.String)" />.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.ComponentModel.Design.DesignerCommandSet.Verbs" /> + </para> + </term> + <description> + <para>Gets the collection of all the designer verbs associated with the designed component. The base implementation simply calls <see cref="M:System.ComponentModel.Design.DesignerCommandSet.GetCommands(System.String)" />.</para> + </description> + </item> + </list> + <para>A <see cref="T:System.ComponentModel.Design.DesignerCommandSet" /> should be added as a site-specific service. Externally, a service of this type should first be queried to discover smart tag and designer verb functionality. If this service is not found, then the <see cref="P:System.ComponentModel.Design.IDesigner.Verbs" /> property should be used instead. This procedure provides a path for backwards compatibility.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a base class for design-time tools, not derived from <see cref="T:System.ComponentModel.Design.ComponentDesigner" />, that provide smart tag or designer verb capabilities.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +72,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Because this base class contains no state, the default constructor does nothing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes an instance of the <see cref="T:System.ComponentModel.Design.DesignerCommandSet" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="ActionLists"> @@ -35,9 +92,15 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The base implementation simply calls <see cref="M:System.ComponentModel.Design.DesignerCommandSet.GetCommands(System.String)" /> with the string parameter "ActionLists".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the collection of all the smart tags associated with the designed component.</para> + </summary> </Docs> </Member> <Member MemberName="GetCommands"> @@ -53,10 +116,45 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Although the base implementation always returns null, the overridden version supplied by the programmer should return a collection of command objects of the type described by <paramref name="name" />. The base implementation of the <see cref="P:System.ComponentModel.Design.DesignerCommandSet.Verbs" /> and <see cref="P:System.ComponentModel.Design.DesignerCommandSet.ActionLists" /> properties specify the following values and meanings for this parameter.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>String </para> + </term> + <description> + <para>Meaning </para> + </description> + </item> + </listheader> + <item> + <term> + <para>"ActionLists"</para> + </term> + <description> + <para>Return a collection of all the smart tags associated with the component.</para> + </description> + </item> + <item> + <term> + <para>"Verbs"</para> + </term> + <description> + <para>Return a collection of all the designer verbs associated with the component.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a collection of command objects.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of collection to return, indicating either a <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> or a <see cref="T:System.ComponentModel.Design.DesignerVerbCollection" />.</param> </Docs> </Member> <Member MemberName="Verbs"> @@ -69,10 +167,16 @@ <ReturnType>System.ComponentModel.Design.DesignerVerbCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The base implementation simply calls <see cref="M:System.ComponentModel.Design.DesignerCommandSet.GetCommands(System.String)" /> with the string parameter "Verbs".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the collection of all the designer verbs associated with the designed component.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DisplayMode.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DisplayMode.xml index 70ea192222d..0723d5c1a27 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DisplayMode.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/DisplayMode.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DisplayMode" FullName="System.ComponentModel.Design.DisplayMode"> <TypeSignature Language="C#" Value="public enum DisplayMode" /> <AssemblyInfo> @@ -9,8 +10,14 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.DisplayMode" /> identifiers are used to indicate the display mode used to display each byte sequence.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines identifiers that indicate the display modes used by <see cref="T:System.ComponentModel.Design.ByteViewer" />.</para> + </summary> </Docs> <Members> <Member MemberName="Ansi"> @@ -20,7 +27,10 @@ <ReturnType>System.ComponentModel.Design.DisplayMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An ANSI format display.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,7 +44,10 @@ <ReturnType>System.ComponentModel.Design.DisplayMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A display mode that automatically selects a display mode. In this mode, the bytes are examined to determine if they are hexadecimal or printable. If the bytes are in hexadecimal format, the <see cref="F:System.ComponentModel.Design.DisplayMode.Hexdump" /> mode is selected. If the characters match a printable character set, a test is run to automatically select either the <see cref="F:System.ComponentModel.Design.DisplayMode.Ansi" /> or <see cref="F:System.ComponentModel.Design.DisplayMode.Unicode" /> display mode.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -48,7 +61,10 @@ <ReturnType>System.ComponentModel.Design.DisplayMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A hexadecimal format display.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -62,7 +78,10 @@ <ReturnType>System.ComponentModel.Design.DisplayMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A Unicode format display.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -70,4 +89,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/EventBindingService.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/EventBindingService.xml index 69e1a8c35fd..92dbfcab72d 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/EventBindingService.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/EventBindingService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="EventBindingService" FullName="System.ComponentModel.Design.EventBindingService"> <TypeSignature Language="C#" Value="public abstract class EventBindingService : System.ComponentModel.Design.IEventBindingService" /> <AssemblyInfo> @@ -13,8 +14,14 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>By providing a service for registering event handlers for component events, <see cref="T:System.ComponentModel.Design.EventBindingService" /> provides a way to link an event handler with a component event from designer code.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A default implementation of the <see cref="T:System.ComponentModel.Design.IEventBindingService" /> interface.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,9 +34,13 @@ <Parameter Name="provider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="provider">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.EventBindingService" /> class. </para> + </summary> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />The service provider from which <see cref="T:System.ComponentModel.Design.EventBindingService" /> will query for services.</param> </Docs> </Member> <Member MemberName="CreateUniqueMethodName"> @@ -46,11 +57,18 @@ <Parameter Name="eventDescriptor" Type="System.ComponentModel.EventDescriptor" /> </Parameters> <Docs> - <param name="component">To be added.</param> <param name="eventDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The name returned by the <see cref="M:System.ComponentModel.Design.EventBindingService.CreateUniqueMethodName(System.ComponentModel.IComponent,System.ComponentModel.EventDescriptor)" /> method must be compatible with the script language being used and it must not conflict with any other name in your code.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a unique method name.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component for which the method name will be created.</param> </Docs> </Member> <Member MemberName="FreeMethod"> @@ -68,11 +86,20 @@ <Parameter Name="methodName" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="e">To be added.</param> - <param name="methodName">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Some implementations may intend to remove the event hander when no events are using it. By overriding <see cref="M:System.ComponentModel.Design.EventBindingService.UseMethod(System.ComponentModel.IComponent,System.ComponentModel.EventDescriptor,System.String)" /> and <see cref="M:System.ComponentModel.Design.EventBindingService.FreeMethod(System.ComponentModel.IComponent,System.ComponentModel.EventDescriptor,System.String)" />, an implementation can infer when a method is no longer needed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a notification that a particular method is no longer being used by an event handler.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to which the method is bound.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.EventDescriptor" /> for the event handler.</param> + <param name="methodName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the method to be freed.</param> </Docs> </Member> <Member MemberName="GetCompatibleMethods"> @@ -89,9 +116,15 @@ </Parameters> <Docs> <param name="eventDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Each string returned in the collection is the method name of a method whose signature is compatible with the delegate contained in <paramref name="e" />. <see cref="M:System.ComponentModel.Design.EventBindingService.GetCompatibleMethods(System.ComponentModel.EventDescriptor)" /> should return an empty collection if no names are compatible.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a collection of names of compatible methods.</para> + </summary> </Docs> </Member> <Member MemberName="GetService"> @@ -108,9 +141,12 @@ </Parameters> <Docs> <param name="service">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the requested service from the service provider.</para> + </summary> </Docs> </Member> <Member MemberName="ShowCode"> @@ -124,9 +160,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.EventBindingService.ShowCode" /> method does not display any particular code; generally it displays the last code the user typed. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays user code.</para> + </summary> </Docs> </Member> <Member MemberName="ShowCode"> @@ -142,10 +184,17 @@ <Parameter Name="lineNumber" Type="System.Int32" /> </Parameters> <Docs> - <param name="lineNumber">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Line numbers are one-based.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays the user code at the given line number.</para> + </summary> + <param name="lineNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The line number to show.</param> </Docs> </Member> <Member MemberName="ShowCode"> @@ -163,12 +212,21 @@ <Parameter Name="methodName" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="e">To be added.</param> - <param name="methodName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.EventBindingService.ShowCode(System.ComponentModel.IComponent,System.ComponentModel.EventDescriptor,System.String)" /> method displays the body of the user code with the given method name.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays the user code for the specified method.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to which the method is bound.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.EventDescriptor" /> for the event handler.</param> + <param name="methodName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the method for which to display code.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IEventBindingService.CreateUniqueMethodName"> @@ -185,11 +243,15 @@ <Parameter Name="eventDescriptor" Type="System.ComponentModel.EventDescriptor" /> </Parameters> <Docs> - <param name="component">To be added.</param> <param name="eventDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a unique name for an event-handler method for the specified component and event.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component instance the event is connected to.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IEventBindingService.GetCompatibleMethods"> @@ -206,9 +268,15 @@ </Parameters> <Docs> <param name="eventDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Each string returned in the collection is the method name of a method whose signature is compatible with the delegate contained in <paramref name="e" />. <see cref="M:System.ComponentModel.Design.EventBindingService.GetCompatibleMethods(System.ComponentModel.EventDescriptor)" /> should return an empty collection if no names are compatible.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of event-handler methods that have a method signature compatible with the specified event.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IEventBindingService.GetEvent"> @@ -224,10 +292,14 @@ <Parameter Name="property" Type="System.ComponentModel.PropertyDescriptor" /> </Parameters> <Docs> - <param name="property">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an <see cref="T:System.ComponentModel.EventDescriptor" /> for the event that the specified property descriptor represents, if it represents an event.</para> + </summary> + <param name="property"> + <attribution license="cc4" from="Microsoft" modified="false" />The property that represents an event.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IEventBindingService.GetEventProperties"> @@ -243,10 +315,14 @@ <Parameter Name="events" Type="System.ComponentModel.EventDescriptorCollection" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts a set of event descriptors to a set of property descriptors.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />The events to convert to properties.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IEventBindingService.GetEventProperty"> @@ -263,9 +339,12 @@ </Parameters> <Docs> <param name="eventDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts a single event descriptor to a property descriptor.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IEventBindingService.ShowCode"> @@ -279,9 +358,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays the user code for the designer.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IEventBindingService.ShowCode"> @@ -297,10 +379,14 @@ <Parameter Name="lineNumber" Type="System.Int32" /> </Parameters> <Docs> - <param name="lineNumber">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays the user code for the designer at the specified line.</para> + </summary> + <param name="lineNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The line number to place the caret on.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IEventBindingService.ShowCode"> @@ -317,11 +403,15 @@ <Parameter Name="eventDescriptor" Type="System.ComponentModel.EventDescriptor" /> </Parameters> <Docs> - <param name="component">To be added.</param> <param name="eventDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays the user code for the specified event.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component that the event is connected to.</param> </Docs> </Member> <Member MemberName="UseMethod"> @@ -339,11 +429,20 @@ <Parameter Name="methodName" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="e">To be added.</param> - <param name="methodName">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Some implementations may intend to remove the event hander when no events are using it. By overriding <see cref="M:System.ComponentModel.Design.EventBindingService.UseMethod(System.ComponentModel.IComponent,System.ComponentModel.EventDescriptor,System.String)" /> and <see cref="M:System.ComponentModel.Design.EventBindingService.FreeMethod(System.ComponentModel.IComponent,System.ComponentModel.EventDescriptor,System.String)" />, an implementation can infer when a method is no longer needed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a notification that a particular method is being used by an event handler.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to which the method is bound.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.EventDescriptor" /> for the event handler.</param> + <param name="methodName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the method.</param> </Docs> </Member> <Member MemberName="ValidateMethodName"> @@ -359,10 +458,17 @@ <Parameter Name="methodName" Type="System.String" /> </Parameters> <Docs> - <param name="methodName">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation does nothing. You may override this and throw an exception if the name is invalid for your use.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Validates that the provided method name is valid for the language or script being used.</para> + </summary> + <param name="methodName"> + <attribution license="cc4" from="Microsoft" modified="false" />The method name to validate.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ExceptionCollection.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ExceptionCollection.xml index 7abe68f74d3..54184ce3dad 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ExceptionCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ExceptionCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ExceptionCollection" FullName="System.ComponentModel.Design.ExceptionCollection"> <TypeSignature Language="C#" Value="public sealed class ExceptionCollection : Exception" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the collection of exceptions.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +27,13 @@ <Parameter Name="exceptions" Type="System.Collections.ArrayList" /> </Parameters> <Docs> - <param name="exceptions">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.ExceptionCollection" /> class.</para> + </summary> + <param name="exceptions"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Exception" />, containing the objects to populate the collection.</param> </Docs> </Member> <Member MemberName="Exceptions"> @@ -38,9 +46,12 @@ <ReturnType>System.Collections.ArrayList</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the array of <see cref="T:System.Exception" /> objects that represent the collection of exceptions.</para> + </summary> </Docs> </Member> <Member MemberName="GetObjectData"> @@ -57,11 +68,16 @@ <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data needed to serialize the <see cref="T:System.ComponentModel.Design.ExceptionCollection" />.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />The destination (see <see cref="T:System.Runtime.Serialization.StreamingContext" />) for this serialization.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/IComponentDesignerDebugService.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/IComponentDesignerDebugService.xml index c2f097d44c8..055587c2837 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/IComponentDesignerDebugService.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/IComponentDesignerDebugService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IComponentDesignerDebugService" FullName="System.ComponentModel.Design.IComponentDesignerDebugService"> <TypeSignature Language="C#" Value="public interface IComponentDesignerDebugService" /> <AssemblyInfo> @@ -6,8 +7,11 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides debugging services in a design-time environment.</para> + </summary> </Docs> <Members> <Member MemberName="Assert"> @@ -24,10 +28,18 @@ <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <param name="condition">To be added.</param> - <param name="message">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.IComponentDesignerDebugService.Assert(System.Boolean,System.String)" /> method enables a designer to assert on a condition inside a design-time environment.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Asserts on a condition inside a design-time environment.</para> + </summary> + <param name="condition"> + <attribution license="cc4" from="Microsoft" modified="false" />true to prevent <paramref name="message" /> from being displayed; otherwise, false.</param> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The message to display.</param> </Docs> </Member> <Member MemberName="Fail"> @@ -43,9 +55,16 @@ <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.IComponentDesignerDebugService.Fail(System.String)" /> method enables a designer to log failure messages inside a design-time environment.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Logs a failure message inside a design-time environment.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The message to log.</param> </Docs> </Member> <Member MemberName="IndentLevel"> @@ -58,9 +77,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.IComponentDesignerDebugService.IndentLevel" /> property enables a designer to change the indent level for debug output.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the indent level for debug output.</para> + </summary> </Docs> </Member> <Member MemberName="Listeners"> @@ -73,9 +98,15 @@ <ReturnType>System.Diagnostics.TraceListenerCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.IComponentDesignerDebugService.Listeners" /> property enables objects to monitor design-time debugging output.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of trace listeners for monitoring design-time debugging output.</para> + </summary> </Docs> </Member> <Member MemberName="Trace"> @@ -92,11 +123,19 @@ <Parameter Name="category" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="category">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.IComponentDesignerDebugService.Trace(System.String,System.String)" /> method enables a designer to log debug messages inside a design-time environment.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Logs a debug message inside a design-time environment.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The message to log.</param> + <param name="category"> + <attribution license="cc4" from="Microsoft" modified="false" />The category of <paramref name="message" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/IComponentDesignerStateService.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/IComponentDesignerStateService.xml index 97f82ba6b8d..a70106c0965 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/IComponentDesignerStateService.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/IComponentDesignerStateService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IComponentDesignerStateService" FullName="System.ComponentModel.Design.IComponentDesignerStateService"> <TypeSignature Language="C#" Value="public interface IComponentDesignerStateService" /> <AssemblyInfo> @@ -6,8 +7,18 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Designer state is keyed by the component with which the designer is associated. The Web Forms design surface offers this service and component designers use the service. This is an optional host service, and control designers should not assume it will always be provided. </para> + <para>Designer state is represented as a set of name/value pairs, in the form of a dictionary. Values stored in the dictionary must be serializable. The specified component should be sited in the designer and should have a non-empty name.</para> + <block subset="none" type="note"> + <para>Do not store sensitive information to the <see cref="T:System.ComponentModel.Design.IComponentDesignerStateService" />. Sensitive information includes password and authentication data, or any data you do not want to expose to an unwanted source. </para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to store and retrieve its state.</para> + </summary> </Docs> <Members> <Member MemberName="GetState"> @@ -24,11 +35,16 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="key">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a state item specified by the key for the given component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component for which to retrieve the designer state item.</param> + <param name="key"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the designer state item.</param> </Docs> </Member> <Member MemberName="SetState"> @@ -46,12 +62,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="key">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets a state item specified by the key for the given component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component for which to set the designer state item.</param> + <param name="key"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the designer state item.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The designer state item for <paramref name="component" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/InheritanceService.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/InheritanceService.xml index 09bdc432b7d..863fa33d7b3 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/InheritanceService.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/InheritanceService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="InheritanceService" FullName="System.ComponentModel.Design.InheritanceService"> <TypeSignature Language="C#" Value="public class InheritanceService : IDisposable, System.ComponentModel.Design.IInheritanceService" /> <AssemblyInfo> @@ -17,8 +18,14 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.InheritanceService" /> can be used to find inherited components, select which ones to ignore, and retrieve the inheritance attribute of each inherited class that is tracked by the service.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a set of methods for identifying inherited components.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -26,8 +33,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.InheritanceService" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -45,10 +55,18 @@ <Parameter Name="container" Type="System.ComponentModel.IContainer" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="container">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method searches all the fields of all base classes of the specified component. Each field that implements <see cref="T:System.ComponentModel.IComponent" /> is added to the specified container.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the components inherited by the specified component to the <see cref="T:System.ComponentModel.Design.InheritanceService" />.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to search for inherited components to add to the specified container. </param> + <param name="container"> + <attribution license="cc4" from="Microsoft" modified="false" />The container to add the inherited components to. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -67,11 +85,20 @@ <Parameter Name="container" Type="System.ComponentModel.IContainer" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <param name="component">To be added.</param> - <param name="container">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method searches all the fields of all base classes of component. Each field that implements <see cref="T:System.ComponentModel.IComponent" /> is added to an internal list that stores an <see cref="T:System.ComponentModel.InheritanceAttribute" /> that identifies the inheritance level of the component. The component is then added to the specified container.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the components of the specified type that are inherited by the specified component to the <see cref="T:System.ComponentModel.Design.InheritanceService" />.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The base type to search for. </param> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to search for inherited components to add to the specified container. </param> + <param name="container"> + <attribution license="cc4" from="Microsoft" modified="false" />The container to add the inherited components to. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -86,8 +113,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Calling <see cref="M:System.ComponentModel.Design.InheritanceService.Dispose" /> allows the resources used by the <see cref="T:System.ComponentModel.Design.InheritanceService" /> to be reallocated for other purposes. For more information about <see cref="M:System.ComponentModel.Design.InheritanceService.Dispose" />, see <format type="text/html"><a href="a17b0066-71c2-4ba4-9822-8e19332fc213">Cleaning Up Unmanaged Resources</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases all resources used by the <see cref="T:System.ComponentModel.Design.InheritanceService" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -107,9 +140,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.ComponentModel.Design.InheritanceService" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Design.InheritanceService" /> and optionally releases the managed resources. </para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> </Member> <Member MemberName="GetInheritanceAttribute"> @@ -122,10 +163,17 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the component is not inherited, this method returns the value <see cref="F:System.ComponentModel.InheritanceAttribute.NotInherited" />. Otherwise, it returns the inheritance attribute for this component.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the inheritance attribute of the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to retrieve the inheritance attribute for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -143,11 +191,16 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="member">To be added.</param> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether to ignore the specified member.</para> + </summary> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />The member to check. This member is either a <see cref="T:System.Reflection.FieldInfo" /> or a <see cref="T:System.Reflection.MethodInfo" />. </param> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component instance this member is bound to. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -155,4 +208,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LoadedEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LoadedEventArgs.xml index 187ce45215b..17f77987444 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LoadedEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LoadedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="LoadedEventArgs" FullName="System.ComponentModel.Design.LoadedEventArgs"> <TypeSignature Language="C#" Value="public sealed class LoadedEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:System.ComponentModel.Design.DesignSurface.Loaded" /> event. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +28,15 @@ <Parameter Name="errors" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="succeeded">To be added.</param> - <param name="errors">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.LoadedEventArgs" /> class.</para> + </summary> + <param name="succeeded"> + <attribution license="cc4" from="Microsoft" modified="false" />true to indicate that the designer load was successful; otherwise, false.</param> + <param name="errors"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection of errors that occurred while the designer was loading.</param> </Docs> </Member> <Member MemberName="Errors"> @@ -40,9 +49,12 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of errors that occurred while the designer was loading.</para> + </summary> </Docs> </Member> <Member MemberName="HasSucceeded"> @@ -55,10 +67,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Even successful loads can have errors if the errors were not too severe to prevent the designer from loading.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the designer load was successful.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LoadedEventHandler.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LoadedEventHandler.xml index 249860b4eb5..3b6802e9fb0 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LoadedEventHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LoadedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="LoadedEventHandler" FullName="System.ComponentModel.Design.LoadedEventHandler"> <TypeSignature Language="C#" Value="public delegate void LoadedEventHandler(object sender, LoadedEventArgs e);" /> <AssemblyInfo> @@ -17,7 +18,13 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When you create a <see cref="T:System.ComponentModel.Design.LoadedEventHandler" /> delegate, you identify a method to handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:System.ComponentModel.Design.DesignSurface.Loaded" /> event of the <see cref="T:System.ComponentModel.Design.DesignSurface" /> class. This class cannot be inherited.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LocalizationExtenderProvider.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LocalizationExtenderProvider.xml index d11cd994285..91738cce0b7 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LocalizationExtenderProvider.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/LocalizationExtenderProvider.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="LocalizationExtenderProvider" FullName="System.ComponentModel.Design.LocalizationExtenderProvider"> <TypeSignature Language="C#" Value="public class LocalizationExtenderProvider : IDisposable, System.ComponentModel.IExtenderProvider" /> <AssemblyInfo> @@ -31,8 +32,17 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" /> can extend an <see cref="T:System.ComponentModel.Design.IRootDesigner" /> with a set of properties and methods that provide support for the .NET Framework localization architecture. For more about using resources, see <format type="text/html"><a href="49d520d7-92d7-44ee-bb24-8b615db1d41b">Localization</a></format>.</para> + <para>The localization support architecture enables designers to initialize component properties using resource files that can be swapped at run time to support a variety of languages, culture-specific styles and dynamically configurable features. You can use the methods of this class to enable designers and code generating serializers to load from resources and build initialization code that uses localization features.</para> + <para>The default serializers that ship with Visual Studio are already capable of localizing components and controls, but they only do so if they locate support for the .NET Framework localization architecture. To detect the presence of localization support, the serialization system must locate a public <see cref="T:System.Boolean" /> property named "Localizable" on the root designer component. If a serializer finds this property, it searches for a property of type <see cref="T:System.Globalization.CultureInfo" /> named "Language" to determine the current resource configuration. Default serializers use these properties to determine if it should localize any localizable resources of the component, and if so, what <see cref="T:System.Globalization.CultureInfo" /> format the resource information should be saved in.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support for localization features to a root designer.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -43,10 +53,18 @@ <Parameter Name="baseComponent" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <param name="baseComponent">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>By default, a new <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" /> sets the current language to <see cref="P:System.Globalization.CultureInfo.InvariantCulture" />, which is the generic and default language resource setting. This setting causes a designer to generate code that references the generic language resource. You can create other <see cref="T:System.Globalization.CultureInfo" /> objects to represent and identify other localized resource data that a program can use at run time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" /> class using the specified service provider and base component.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider for the specified component. </param> + <param name="baseComponent"> + <attribution license="cc4" from="Microsoft" modified="false" />The base component to localize. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -63,10 +81,14 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether this object can provide its extender properties to the specified object.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to receive the extender properties. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -81,8 +103,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call <see cref="Overload:System.ComponentModel.Design.LocalizationExtenderProvider.Dispose" /> when you are finished using the <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" />. The <see cref="Overload:System.ComponentModel.Design.LocalizationExtenderProvider.Dispose" /> method leaves the <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" /> in an unusable state. After calling <see cref="Overload:System.ComponentModel.Design.LocalizationExtenderProvider.Dispose" />, you must release all references to the <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" /> 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="Overload:System.ComponentModel.Design.LocalizationExtenderProvider.Dispose" /> before you release your last reference to the <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" /> object's Finalize method.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Disposes of the resources (other than memory) used by the <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -102,9 +133,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Design.LocalizationExtenderProvider" /> and optionally releases the managed resources. </para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> </Member> <Member MemberName="GetLanguage"> @@ -117,10 +156,17 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method returns the current resource culture used to access resource data for the specified object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the current resource culture for the specified object.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to get the current resource culture for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -145,10 +191,14 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the default resource culture to use when initializing the values of a localized object at design time.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to get the resource culture for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -176,10 +226,14 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the specified object supports resource localization.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to check for localization support. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -204,9 +258,16 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the specified object was initialized with localized resources when the designer loaded, this method sets the resource culture for the specified object to the resource culture used to initialize the values of the specified object when the designer loaded. If the specified object had no previous resource culture setting, the current resource culture is set to <see cref="P:System.Globalization.CultureInfo.InvariantCulture" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Resets the resource culture for the specified object.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to reset the resource culture for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -224,10 +285,15 @@ <Parameter Name="language" Type="System.Globalization.CultureInfo" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <param name="language">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the current resource culture for the specified object to the specified resource culture.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The base component to set the resource culture for. </param> + <param name="language"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Globalization.CultureInfo" /> that indicates the resource culture to use. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -245,10 +311,15 @@ <Parameter Name="localizable" Type="System.Boolean" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <param name="localizable">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets a value indicating whether the specified object supports localized resources.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The base component to set as localizable or not localizable. </param> + <param name="localizable"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the object supports resource localization; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -265,10 +336,14 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the specified object must have its localizable values persisted in a resource.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to get the language support persistence flag for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -276,4 +351,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandService.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandService.xml index 42125f3c311..957f304a974 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandService.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MenuCommandService" FullName="System.ComponentModel.Design.MenuCommandService"> <TypeSignature Language="C#" Value="public class MenuCommandService : IDisposable, System.ComponentModel.Design.IMenuCommandService" /> <AssemblyInfo> @@ -16,8 +17,64 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.MenuCommandService" /> class implements the <see cref="T:System.ComponentModel.Design.IMenuCommandService" /> interface, which is the managed interface used to add handlers for menu commands and to define verbs.</para> + <para>The <see cref="T:System.ComponentModel.Design.MenuCommandService" /> class is automatically offered by the package class to offer global commands for an entire package, and it is also offered by the Microsoft.VisualStudio.Shell.WindowPane class to offer commands for the current window. This offering is always done through the service container, so anyone deriving from the package or window pane classes can remove or replace the default implementation of the <see cref="T:System.ComponentModel.Design.IMenuCommandService" /> interface.</para> + <para>The <see cref="T:System.ComponentModel.Design.MenuCommandService" /> class utilizes several other services. All of these services are optional, so the behavior of the <see cref="T:System.ComponentModel.Design.MenuCommandService" /> class degrades if one or more services are missing. The following table shows which services are used and for what purpose.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Service</para> + </term> + <description> + <para>Purpose</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.ISelectionService" /> + </para> + </term> + <description> + <para>Used to discover the current selection in order to obtain verbs offered by the currently selected designer.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IDesignerHost" /> + </para> + </term> + <description> + <para>Used to obtain the designer for the currently selected component, if any.</para> + </description> + </item> + <item> + <term> + <para>Microsoft.VisualStudio.Shell.Interop.IVsUIShell</para> + </term> + <description> + <para>Used to notify vsprvs that the command status has changed.</para> + </description> + </item> + <item> + <term> + <para>Microsoft.VisualStudio.Shell.Interop.IOleComponentUIManager</para> + </term> + <description> + <para>Used to show context menus.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implements the <see cref="T:System.ComponentModel.Design.IMenuCommandService" /> interface.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -30,9 +87,16 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the service is being used with a designer, the <paramref name="serviceProvider" /> parameter should be the service provider for the designer, as is the case with <see cref="T:System.ComponentModel.Design.DesignSurface" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.MenuCommandService" /> class. </para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The service provider that this service uses to obtain other services.</param> </Docs> </Member> <Member MemberName="AddCommand"> @@ -48,9 +112,16 @@ <Parameter Name="command" Type="System.ComponentModel.Design.MenuCommand" /> </Parameters> <Docs> - <param name="command">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.MenuCommandService.AddCommand(System.ComponentModel.Design.MenuCommand)" /> method adds a command handler to the menu command service. Command handlers do not define the text, shortcut, or placement of a menu item. Rather, they define the menu item’s behavior if the item is clicked. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a command handler to the menu command service.</para> + </summary> + <param name="command"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.MenuCommand" /> to add.</param> </Docs> </Member> <Member MemberName="AddVerb"> @@ -66,9 +137,16 @@ <Parameter Name="verb" Type="System.ComponentModel.Design.DesignerVerb" /> </Parameters> <Docs> - <param name="verb">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This verb is available regardless of what designer is currently selected. Unlike menu commands, verbs can define the text that is displayed to the user, but they do not define the placement of the command on the actual menu.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a verb to the verb table of the <see cref="T:System.ComponentModel.Design.MenuCommandService" />.</para> + </summary> + <param name="verb"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerVerb" /> to add.</param> </Docs> </Member> <Member MemberName="Dispose"> @@ -82,8 +160,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call <see cref="M:System.ComponentModel.Design.MenuCommandService.Dispose" /> when you are finished using the <see cref="T:System.ComponentModel.Design.MenuCommandService" />. The <see cref="M:System.ComponentModel.Design.MenuCommandService.Dispose" /> method leaves the <see cref="T:System.ComponentModel.Design.MenuCommandService" /> in an unusable state. After calling <see cref="M:System.ComponentModel.Design.MenuCommandService.Dispose" />, you must release all references to the <see cref="T:System.ComponentModel.Design.MenuCommandService" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Design.MenuCommandService" /> 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.MenuCommandService.Dispose" /> before you release your last reference to the <see cref="T:System.ComponentModel.Design.MenuCommandService" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Design.MenuCommandService" /> 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.MenuCommandService" />.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -99,9 +186,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.ComponentModel.Design.MenuCommandService" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases all resources used by the <see cref="T:System.ComponentModel.Design.MenuCommandService" />.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param> </Docs> </Member> <Member MemberName="EnsureVerbs"> @@ -115,8 +210,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.MenuCommandService.EnsureVerbs" /> method creates the verb list if it has not already been created.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Ensures that the verb list has been created.</para> + </summary> </Docs> </Member> <Member MemberName="FindCommand"> @@ -132,10 +233,14 @@ <Parameter Name="commandID" Type="System.ComponentModel.Design.CommandID" /> </Parameters> <Docs> - <param name="commandID">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Searches for the <see cref="T:System.ComponentModel.Design.MenuCommand" /> associated with the given command ID.</para> + </summary> + <param name="commandID"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.CommandID" /> to find.</param> </Docs> </Member> <Member MemberName="FindCommand"> @@ -152,11 +257,16 @@ <Parameter Name="id" Type="System.Int32" /> </Parameters> <Docs> - <param name="guid">To be added.</param> - <param name="id">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Searches for the <see cref="T:System.ComponentModel.Design.MenuCommand" /> associated with the given command.</para> + </summary> + <param name="guid"> + <attribution license="cc4" from="Microsoft" modified="false" />The GUID of the command.</param> + <param name="id"> + <attribution license="cc4" from="Microsoft" modified="false" />The ID of the command.</param> </Docs> </Member> <Member MemberName="GetCommandList"> @@ -172,10 +282,14 @@ <Parameter Name="guid" Type="System.Guid" /> </Parameters> <Docs> - <param name="guid">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the command list for a given GUID.</para> + </summary> + <param name="guid"> + <attribution license="cc4" from="Microsoft" modified="false" />The GUID of the command list.</param> </Docs> </Member> <Member MemberName="GetService"> @@ -191,10 +305,14 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a reference to the requested service.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the service to retrieve.</param> </Docs> </Member> <Member MemberName="GlobalInvoke"> @@ -210,10 +328,17 @@ <Parameter Name="commandID" Type="System.ComponentModel.Design.CommandID" /> </Parameters> <Docs> - <param name="commandID">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The local form is first searched for the given command ID. If it is found, it is invoked. Otherwise, the command ID is passed to the global environment command handler, if one is available.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Invokes the given command on the local form or in the global environment.</para> + </summary> + <param name="commandID"> + <attribution license="cc4" from="Microsoft" modified="false" />The command to invoke.</param> </Docs> </Member> <Member MemberName="GlobalInvoke"> @@ -231,10 +356,17 @@ </Parameters> <Docs> <param name="commandID">To be added.</param> - <param name="arg">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The local form is first searched for the given command ID. If it is found, it is invoked. Otherwise, the command ID is passed to the global environment command handler, if one is available.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Invokes the given command with the given parameter on the local form or in the global environment.</para> + </summary> + <param name="arg"> + <attribution license="cc4" from="Microsoft" modified="false" />A parameter for the invocation.</param> </Docs> </Member> <Member MemberName="MenuCommandsChanged"> @@ -247,8 +379,14 @@ <ReturnType>System.ComponentModel.Design.MenuCommandsChangedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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 the status of a menu command has changed.</para> + </summary> </Docs> </Member> <Member MemberName="OnCommandsChanged"> @@ -264,9 +402,18 @@ <Parameter Name="e" Type="System.ComponentModel.Design.MenuCommandsChangedEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.ComponentModel.Design.MenuCommandService.OnCommandsChanged(System.ComponentModel.Design.MenuCommandsChangedEventArgs)" /> method is called by a menu command when its status has changed.</para> + <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para> + <para>The <see cref="M:System.ComponentModel.Design.MenuCommandService.OnCommandsChanged(System.ComponentModel.Design.MenuCommandsChangedEventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.MenuCommandService.MenuCommandsChanged" /> event. </para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.MenuCommandsChangedEventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="RemoveCommand"> @@ -282,9 +429,16 @@ <Parameter Name="command" Type="System.ComponentModel.Design.MenuCommand" /> </Parameters> <Docs> - <param name="command">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If there are no more commands in the command group, the group is removed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the given menu command from the document.</para> + </summary> + <param name="command"> + <attribution license="cc4" from="Microsoft" modified="false" />The command to remove.</param> </Docs> </Member> <Member MemberName="RemoveVerb"> @@ -300,9 +454,13 @@ <Parameter Name="verb" Type="System.ComponentModel.Design.DesignerVerb" /> </Parameters> <Docs> - <param name="verb">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the given verb from the document.</para> + </summary> + <param name="verb"> + <attribution license="cc4" from="Microsoft" modified="false" />The verb to remove.</param> </Docs> </Member> <Member MemberName="ShowContextMenu"> @@ -320,11 +478,20 @@ <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> - <param name="menuID">To be added.</param> - <param name="x">To be added.</param> - <param name="y">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation does nothing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Shows the shortcut menu with the given command ID at the given location.</para> + </summary> + <param name="menuID"> + <attribution license="cc4" from="Microsoft" modified="false" />The shortcut menu to display.</param> + <param name="x"> + <attribution license="cc4" from="Microsoft" modified="false" />The x-coordinate of the shortcut menu's location.</param> + <param name="y"> + <attribution license="cc4" from="Microsoft" modified="false" />The y-coordinate of the shortcut menu's location.</param> </Docs> </Member> <Member MemberName="Verbs"> @@ -337,10 +504,25 @@ <ReturnType>System.ComponentModel.Design.DesignerVerbCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.ComponentModel.Design.MenuCommandService.Verbs" /> property provides a collection of verbs. These verbs come from two places:</para> + <list type="bullet"> + <item> + <para>Verbs added through the <see cref="M:System.ComponentModel.Design.MenuCommandService.AddVerb(System.ComponentModel.Design.DesignerVerb)" /> method of <see cref="P:System.ComponentModel.Design.MenuCommandService.Verbs" />.</para> + </item> + <item> + <para>Verbs offered by the currently selected designer.</para> + </item> + </list> + <para>Verbs added to this service through the <see cref="M:System.ComponentModel.Design.MenuCommandService.AddVerb(System.ComponentModel.Design.DesignerVerb)" /> method are called global verbs because they are global to this service, but generally there is one instance of this service for each tool or document window. Designer verbs are obtained by querying the service provider for <see cref="T:System.ComponentModel.Design.IDesignerHost" /> and <see cref="T:System.ComponentModel.Design.ISelectionService" />. If the selection service offers a primary selection, and a designer can be obtained for that selection from <see cref="T:System.ComponentModel.Design.IDesignerHost" />, the designer’s verbs are added to this list. If the name of a global verb conflicts with the name of a designer verb, the designer-provided designer verb takes precedence.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of the designer verbs that are currently available.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedEventArgs.xml index 232a4a0bef0..971bd470e4e 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MenuCommandsChangedEventArgs" FullName="System.ComponentModel.Design.MenuCommandsChangedEventArgs"> <TypeSignature Language="C#" Value="public class MenuCommandsChangedEventArgs : EventArgs" /> <AssemblyInfo> @@ -14,8 +15,11 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:System.ComponentModel.Design.MenuCommandService.MenuCommandsChanged" /> event.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -29,10 +33,15 @@ <Parameter Name="command" Type="System.ComponentModel.Design.MenuCommand" /> </Parameters> <Docs> - <param name="changeType">To be added.</param> - <param name="command">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.MenuCommandsChangedEventArgs" /> class.</para> + </summary> + <param name="changeType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of change.</param> + <param name="command"> + <attribution license="cc4" from="Microsoft" modified="false" />The menu command.</param> </Docs> </Member> <Member MemberName="ChangeType"> @@ -45,9 +54,12 @@ <ReturnType>System.ComponentModel.Design.MenuCommandsChangedType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type of change that caused <see cref="E:System.ComponentModel.Design.MenuCommandService.MenuCommandsChanged" /> to be raised.</para> + </summary> </Docs> </Member> <Member MemberName="Command"> @@ -60,10 +72,16 @@ <ReturnType>System.ComponentModel.Design.MenuCommand</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The returned value can be null if more than one command changed at once.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the command that was added, removed, or changed.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedEventHandler.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedEventHandler.xml index 0ee48daaa14..a07362c8eca 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedEventHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MenuCommandsChangedEventHandler" FullName="System.ComponentModel.Design.MenuCommandsChangedEventHandler"> <TypeSignature Language="C#" Value="public delegate void MenuCommandsChangedEventHandler(object sender, MenuCommandsChangedEventArgs e);" /> <AssemblyInfo> @@ -22,7 +23,13 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When you create a <see cref="T:System.ComponentModel.Design.MenuCommandsChangedEventHandler" /> delegate, you identify a method to handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:System.ComponentModel.Design.MenuCommandService.MenuCommandsChanged" /> event of a <see cref="T:System.ComponentModel.Design.MenuCommandService" />. This class cannot be inherited.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedType.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedType.xml index bba9e35f70f..480a76791c2 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedType.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MenuCommandsChangedType.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MenuCommandsChangedType" FullName="System.ComponentModel.Design.MenuCommandsChangedType"> <TypeSignature Language="C#" Value="public enum MenuCommandsChangedType" /> <AssemblyInfo> @@ -13,8 +14,11 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the type of action that occurred to the related object's <see cref="T:System.Windows.Forms.Design.MenuCommands" /> collection.</para> + </summary> </Docs> <Members> <Member MemberName="CommandAdded"> @@ -27,7 +31,10 @@ <ReturnType>System.ComponentModel.Design.MenuCommandsChangedType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies that one or more command objects were added.</para> + </summary> </Docs> </Member> <Member MemberName="CommandChanged"> @@ -40,7 +47,10 @@ <ReturnType>System.ComponentModel.Design.MenuCommandsChangedType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies that one or more commands have changed their status.</para> + </summary> </Docs> </Member> <Member MemberName="CommandRemoved"> @@ -53,8 +63,11 @@ <ReturnType>System.ComponentModel.Design.MenuCommandsChangedType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies that one or more commands were removed.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MultilineStringEditor.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MultilineStringEditor.xml index 4d36a79f433..f4abc7ee9a6 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MultilineStringEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/MultilineStringEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MultilineStringEditor" FullName="System.ComponentModel.Design.MultilineStringEditor"> <TypeSignature Language="C#" Value="public sealed class MultilineStringEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays a dialog for editing multi-line strings in design mode.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.MultilineStringEditor" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="EditValue"> @@ -40,12 +47,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the specified object value using the edit style provided by <see cref="M:System.Drawing.Design.ImageEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" />.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which editing services can be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the value being edited. </param> </Docs> </Member> <Member MemberName="GetEditStyle"> @@ -61,10 +74,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editing style of the <see cref="M:System.Drawing.Design.ImageEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> </Member> <Member MemberName="GetPaintValueSupported"> @@ -80,11 +97,15 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether this editor supports painting a representation of an object's value.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ObjectSelectorEditor.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ObjectSelectorEditor.xml index 00c48aca1b2..a4f491f1924 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ObjectSelectorEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/ObjectSelectorEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ObjectSelectorEditor" FullName="System.ComponentModel.Design.ObjectSelectorEditor"> <TypeSignature Language="C#" Value="public abstract class ObjectSelectorEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implements the basic functionality that can be used to design value editors. These editors can, in turn, provide a user interface for representing and editing the values of objects of the supported data types.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.ObjectSelectorEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +41,13 @@ <Parameter Name="subObjectSelector" Type="System.Boolean" /> </Parameters> <Docs> - <param name="subObjectSelector">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.ObjectSelectorEditor" /> class.</para> + </summary> + <param name="subObjectSelector"> + <attribution license="cc4" from="Microsoft" modified="false" />The specified sub-object selector value.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -50,8 +61,11 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the current value of <see cref="T:System.ComponentModel.Design.ObjectSelectorEditor" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -70,12 +84,21 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A service provider is provided so that the editor can obtain any required services.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the specified object using the editor style indicated by <see cref="Overload:System.ComponentModel.Design.ObjectSelectorEditor.GetEditStyle" />.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information.</param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> that this editor can use to obtain services.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to edit.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -92,10 +115,14 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the specified <see cref="T:System.Object" /> is equal to the current <see cref="T:System.Object" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> to compare with the current <see cref="T:System.Object" />.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -135,10 +162,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editor style used by the <see cref="Overload:System.ComponentModel.Design.ObjectSelectorEditor.EditValue" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -152,8 +183,11 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the previous value of <see cref="T:System.ComponentModel.Design.ObjectSelectorEditor" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -170,9 +204,13 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the current <see cref="T:System.ComponentModel.Design.ObjectSelectorEditor" /> to the specified value.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The specified value.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -186,8 +224,11 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Controls whether or not the nodes within the hierarchical collection of labeled items are accessible.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -195,4 +236,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/UndoEngine.xml b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/UndoEngine.xml index ede6b420b98..17e964dadc7 100644 --- a/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/UndoEngine.xml +++ b/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design/UndoEngine.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="UndoEngine" FullName="System.ComponentModel.Design.UndoEngine"> <TypeSignature Language="C#" Value="public abstract class UndoEngine : IDisposable" /> <AssemblyInfo> @@ -13,8 +14,78 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.UndoEngine" /> abstract class provides a default implementation of undo functionality at design time. An undo unit represents a single unit of undoable work. This unit is added to a stack and the user can then walk the stack to undo each action. Undo units typically are designed to toggle, which means that calling undo twice returns the application to its starting state.</para> + <para>The <see cref="T:System.ComponentModel.Design.UndoEngine" /> class takes advantage of the following characteristics of objects running within the designer:</para> + <list type="bullet"> + <item> + <para>All interesting objects can be persisted to some format by the designer loader.</para> + </item> + <item> + <para>All objects raise property-change notifications when a property is changed.</para> + </item> + <item> + <para> + <see cref="T:System.ComponentModel.Design.IDesignerHost" /> offers the idea of transactions, which can be used to fabricate an undo action that spans multiple smaller actions.</para> + </item> + </list> + <para>With these features, <see cref="T:System.ComponentModel.Design.UndoEngine" /> can fabricate any undo units it needs automatically. </para> + <block subset="none" type="note"> + <para>Do not change property values directly. The <see cref="T:System.ComponentModel.Design.UndoEngine" /> class requires you to use the appropriate <see cref="T:System.ComponentModel.TypeDescriptor" /> to change property values.</para> + </block> + <para> + <see cref="T:System.ComponentModel.Design.UndoEngine" /> monitors for change notifications to create undo units, and the units themselves consist of serialized object states. The following table shows the services that must be available when <see cref="T:System.ComponentModel.Design.UndoEngine" /> is created.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Service</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.Serialization.ComponentSerializationService" /> </para> + </term> + <description> + <para>Saves property and object values for a component before and after a change is made.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> + </para> + </term> + <description> + <para>Notifies the undo engine of changes made to components.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="T:System.ComponentModel.Design.IDesignerHost" /> + </para> + </term> + <description> + <para>Used to track transactions.</para> + </description> + </item> + </list> + <block subset="none" type="note"> + <para>Because the <see cref="T:System.ComponentModel.Design.UndoEngine" /> class requires <see cref="T:System.ComponentModel.Design.Serialization.ComponentSerializationService" /> and <see cref="T:System.ComponentModel.Design.IComponentChangeService" />, it is available only at design time.</para> + </block> + <para>The undo engine tracks transactions and creates a single undo unit that encompasses a transaction. As a result, the undo engine has control over the duration of an undoable action. Also, because transactions can be named, undoable actions inherit their names from the current transaction. If no transaction is available and a change is reported, the undo engine creates an undo name based on the type of change (for example, "Change property 'Text'").</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies generic undo/redo functionality at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,9 +98,16 @@ <Parameter Name="provider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="provider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.ComponentModel.Design.UndoEngine" /> requires several services from the <paramref name="provider" /> parameter to be useful.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.UndoEngine" /> class.</para> + </summary> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A parenting service provider.</param> </Docs> </Member> <Member MemberName="AddUndoUnit"> @@ -64,11 +142,20 @@ <Parameter Name="primary" Type="System.Boolean" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="primary">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation of the <see cref="M:System.ComponentModel.Design.UndoEngine.CreateUndoUnit(System.String,System.Boolean)" /> method simply returns a new <see cref="T:System.ComponentModel.Design.UndoEngine.UndoUnit" />. </para> + <para>By default, <see cref="T:System.ComponentModel.Design.UndoEngine" /> does nothing with the <paramref name="primary" /> parameter, but some implementations of undo, such as those involving the COM Microsoft.VisualStudio.OLE.Interop.IOleParentUndoUnit design pattern, may need to identify the difference between a primary unit and its children. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new <see cref="T:System.ComponentModel.Design.UndoEngine.UndoUnit" />.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the unit to create. </param> + <param name="primary"> + <attribution license="cc4" from="Microsoft" modified="false" />true to create the first of a series of nested units; false to create subsequent nested units.</param> </Docs> </Member> <Member MemberName="DiscardUndoUnit"> @@ -100,8 +187,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases all resources used by the <see cref="T:System.ComponentModel.Design.UndoEngine" />.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -117,9 +207,13 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Design.UndoEngine" /> and optionally releases the managed resources. </para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> </Member> <Member MemberName="Enabled"> @@ -132,9 +226,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enables or disables the <see cref="T:System.ComponentModel.Design.UndoEngine" />.</para> + </summary> </Docs> </Member> <Member MemberName="GetRequiredService"> @@ -150,10 +247,14 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the requested service.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of service to retrieve.</param> </Docs> </Member> <Member MemberName="GetService"> @@ -169,10 +270,14 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the requested service.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of service to retrieve.</param> </Docs> </Member> <Member MemberName="OnUndoing"> @@ -188,9 +293,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.UndoEngine.Undoing" /> event. </para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="OnUndone"> @@ -206,9 +315,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.ComponentModel.Design.UndoEngine.Undone" /> event. </para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param> </Docs> </Member> <Member MemberName="Undoing"> @@ -221,8 +334,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs immediately before an undo action is performed.</para> + </summary> </Docs> </Member> <Member MemberName="UndoInProgress"> @@ -235,9 +351,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates if an undo action is in progress.</para> + </summary> </Docs> </Member> <Member MemberName="Undone"> @@ -250,9 +369,15 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.ComponentModel.Design.UndoEngine.Undone" /> event is always raised, even if an exception is thrown.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs immediately after an undo action is performed.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Data.Design/MethodSignatureGenerator.xml b/mcs/class/System.Design/Documentation/en/System.Data.Design/MethodSignatureGenerator.xml index b8311555698..ecad95679d3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Data.Design/MethodSignatureGenerator.xml +++ b/mcs/class/System.Design/Documentation/en/System.Data.Design/MethodSignatureGenerator.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MethodSignatureGenerator" FullName="System.Data.Design.MethodSignatureGenerator"> <TypeSignature Language="C#" Value="public class MethodSignatureGenerator" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This class is used to generate a database query method signature, as it will be created by the typed dataset generator.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the MethodSignatureGenerator class.</para> + </summary> </Docs> </Member> <Member MemberName="CodeProvider"> @@ -35,9 +42,12 @@ <ReturnType>System.CodeDom.Compiler.CodeDomProvider</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> object.</para> + </summary> </Docs> </Member> <Member MemberName="ContainerParameterType"> @@ -50,9 +60,12 @@ <ReturnType>System.Type</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the type of object that the query will fill.</para> + </summary> </Docs> </Member> <Member MemberName="DataSetClassName"> @@ -65,9 +78,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the type name of the typed dataset to be filled.</para> + </summary> </Docs> </Member> <Member MemberName="GenerateMethod"> @@ -81,9 +97,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the code member method representing the database query, as generated by the typed dataset generator.</para> + </summary> </Docs> </Member> <Member MemberName="GenerateMethodSignature"> @@ -97,9 +116,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a string representing the database query method signature, as generated by the typed dataset generator.</para> + </summary> </Docs> </Member> <Member MemberName="GenerateUpdatingMethods"> @@ -113,9 +135,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a code type declaration containing the Insert, Update, and Delete methods associated with the database query.</para> + </summary> </Docs> </Member> <Member MemberName="IsGetMethod"> @@ -128,9 +153,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a Boolean value specifying whether the signature generated needs to return a <see cref="T:System.Data.DataTable" /> object.</para> + </summary> </Docs> </Member> <Member MemberName="PagingMethod"> @@ -143,9 +171,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a Boolean value specifying whether the method supports paging.</para> + </summary> </Docs> </Member> <Member MemberName="ParameterOption"> @@ -158,9 +189,15 @@ <ReturnType>System.Data.Design.ParameterGenerationOption</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For more information, see <see cref="T:System.Data.Design.ParameterGenerationOption" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the category of types to use for parameters.</para> + </summary> </Docs> </Member> <Member MemberName="SetDesignTableContent"> @@ -176,9 +213,18 @@ <Parameter Name="designTableContent" Type="System.String" /> </Parameters> <Docs> - <param name="designTableContent">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the schema of the design table for which the database query method will be generated.</para> + </summary> + <param name="designTableContent"> + <attribution license="cc4" from="Microsoft" modified="false" />A string representation of the table schema.</param> </Docs> </Member> <Member MemberName="SetMethodSourceContent"> @@ -194,9 +240,18 @@ <Parameter Name="methodSourceContent" Type="System.String" /> </Parameters> <Docs> - <param name="methodSourceContent">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the database query for which the method signature will be generated.</para> + </summary> + <param name="methodSourceContent"> + <attribution license="cc4" from="Microsoft" modified="false" />A string representation of the database query.</param> </Docs> </Member> <Member MemberName="TableClassName"> @@ -209,10 +264,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the type name of the typed table to fill.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Data.Design/ParameterGenerationOption.xml b/mcs/class/System.Design/Documentation/en/System.Data.Design/ParameterGenerationOption.xml index b7fac3793bc..c3405766643 100644 --- a/mcs/class/System.Design/Documentation/en/System.Data.Design/ParameterGenerationOption.xml +++ b/mcs/class/System.Design/Documentation/en/System.Data.Design/ParameterGenerationOption.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ParameterGenerationOption" FullName="System.Data.Design.ParameterGenerationOption"> <TypeSignature Language="C#" Value="public enum ParameterGenerationOption" /> <AssemblyInfo> @@ -8,8 +9,14 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Data.Design.ParameterGenerationOption" /> enumeration is used to tell the <see cref="T:System.Data.Design.MethodSignatureGenerator" /> the type of parameters to generate in a typed dataset.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the type of parameters that are generated in a typed <see cref="T:System.Data.DataSet" /> class.</para> + </summary> </Docs> <Members> <Member MemberName="ClrTypes"> @@ -22,7 +29,10 @@ <ReturnType>System.Data.Design.ParameterGenerationOption</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Parameters in the typed dataset are CLR types.</para> + </summary> </Docs> </Member> <Member MemberName="Objects"> @@ -35,7 +45,10 @@ <ReturnType>System.Data.Design.ParameterGenerationOption</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Parameters in the typed dataset are all of <see cref="T:System.Object" />.</para> + </summary> </Docs> </Member> <Member MemberName="SqlTypes"> @@ -48,8 +61,11 @@ <ReturnType>System.Data.Design.ParameterGenerationOption</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Parameters in the typed dataset are Sql types.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetGenerator.xml b/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetGenerator.xml index 6a98e213968..39894de4bf3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetGenerator.xml +++ b/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetGenerator.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TypedDataSetGenerator" FullName="System.Data.Design.TypedDataSetGenerator"> <TypeSignature Language="C#" Value="public sealed class TypedDataSetGenerator" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Data.TypedDataSetGenerator" /> class takes information provided (for example, an XML schema) and creates a typed dataset class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a strongly typed <see cref="T:System.Data.DataSet" /> class.</para> + </summary> </Docs> <Members> <Member MemberName="Generate"> @@ -28,12 +35,21 @@ <Parameter Name="codeProvider" Type="System.CodeDom.Compiler.CodeDomProvider" /> </Parameters> <Docs> - <param name="dataSet">To be added.</param> - <param name="codeNamespace">To be added.</param> - <param name="codeProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a strongly typed <see cref="T:System.Data.DataSet" />. The dataset is created in the namespace indicated in the <paramref name="codeNamespace" /> parameter, and the dataset is generated in the managed programming language indicated in the <paramref name="codeProvider" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a strongly typed <see cref="T:System.Data.DataSet" /> based on an existing <see cref="T:System.Data.DataSet" />. </para> + </summary> + <param name="dataSet"> + <attribution license="cc4" from="Microsoft" modified="false" />The source <see cref="T:System.Data.DataSet" /> that specifies the metadata for the typed <see cref="T:System.Data.DataSet" />.</param> + <param name="codeNamespace"> + <attribution license="cc4" from="Microsoft" modified="false" />The namespace that provides the target namespace for the typed <see cref="T:System.Data.DataSet" />.</param> + <param name="codeProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The language-specific <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> to use to generate the dataset.</param> </Docs> </Member> <Member MemberName="Generate"> @@ -52,13 +68,26 @@ <Parameter Name="codeProvider" Type="System.CodeDom.Compiler.CodeDomProvider" /> </Parameters> <Docs> - <param name="inputFileContent">To be added.</param> - <param name="compileUnit">To be added.</param> - <param name="mainNamespace">To be added.</param> - <param name="codeProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para> + </block> + <para>Generates a strongly typed <see cref="T:System.Data.DataSet" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a strongly typed <see cref="T:System.Data.DataSet" /> based on the provided input file.</para> + </summary> + <param name="inputFileContent"> + <attribution license="cc4" from="Microsoft" modified="false" />A string that represents the XML schema to base the <see cref="T:System.Data.DataSet" /> on.</param> + <param name="compileUnit"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeCompileUnit" /> to contain the generated code.</param> + <param name="mainNamespace"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeNamespace" /> that contains the generated dataset.</param> + <param name="codeProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The language-specific <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> to use to generate the dataset.</param> </Docs> </Member> <Member MemberName="Generate"> @@ -78,13 +107,27 @@ <Parameter Name="customDBProviders" Type="System.Collections.Hashtable" /> </Parameters> <Docs> - <param name="inputFileContent">To be added.</param> - <param name="compileUnit">To be added.</param> - <param name="mainNamespace">To be added.</param> - <param name="codeProvider">To be added.</param> - <param name="customDBProviders">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para> + </block> + <para>Generates a strongly typed <see cref="T:System.Data.DataSet" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a strongly typed <see cref="T:System.Data.DataSet" /> based on the provided input file.</para> + </summary> + <param name="inputFileContent"> + <attribution license="cc4" from="Microsoft" modified="false" />A string that represents the XML schema to base the <see cref="T:System.Data.DataSet" /> on.</param> + <param name="compileUnit"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeCompileUnit" /> to contain the generated code.</param> + <param name="mainNamespace"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeNamespace" /> that contains the generated dataset.</param> + <param name="codeProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The language specific <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> to use to generate the dataset.</param> + <param name="customDBProviders"> + <attribution license="cc4" from="Microsoft" modified="false" />A HashTable that maps connections to specific providers in the typed dataset.</param> </Docs> </Member> <Member MemberName="Generate"> @@ -104,13 +147,27 @@ <Parameter Name="specifiedFactory" Type="System.Data.Common.DbProviderFactory" /> </Parameters> <Docs> - <param name="inputFileContent">To be added.</param> - <param name="compileUnit">To be added.</param> - <param name="mainNamespace">To be added.</param> - <param name="codeProvider">To be added.</param> - <param name="specifiedFactory">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para> + </block> + <para>Generates a strongly typed <see cref="T:System.Data.DataSet" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a strongly typed <see cref="T:System.Data.DataSet" /> based on the provided input file.</para> + </summary> + <param name="inputFileContent"> + <attribution license="cc4" from="Microsoft" modified="false" />A string that represents the XML schema to base the <see cref="T:System.Data.DataSet" /> on.</param> + <param name="compileUnit"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeCompileUnit" /> to contain the generated code.</param> + <param name="mainNamespace"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeNamespace" /> that contains the generated dataset.</param> + <param name="codeProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The language-specific <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> to use to generate the dataset.</param> + <param name="specifiedFactory"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.Common.DbProviderFactory" /> to use to override the provider contained in the <paramref name="inputFileContent" />.</param> </Docs> </Member> <Member MemberName="Generate"> @@ -181,10 +238,20 @@ <Parameter Name="inputFileContent" Type="System.String" /> </Parameters> <Docs> - <param name="inputFileContent">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para> + </block> + <para>This method returns the first provider name in the specified <paramref name="inputFileContent" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the first provider name found in the provided input file.</para> + </summary> + <param name="inputFileContent"> + <attribution license="cc4" from="Microsoft" modified="false" />A string that represents the XML schema to base the <see cref="T:System.Data.DataSet" /> on.</param> </Docs> </Member> <Member MemberName="GetProviderName"> @@ -201,11 +268,22 @@ <Parameter Name="tableName" Type="System.String" /> </Parameters> <Docs> - <param name="inputFileContent">To be added.</param> - <param name="tableName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para> + </block> + <para>Returns the provider name for the given <paramref name="tableName" /> in the <see cref="T:System.Data.DataSet" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the provider name for the <paramref name="tableName" /> in the input file.</para> + </summary> + <param name="inputFileContent"> + <attribution license="cc4" from="Microsoft" modified="false" />A string that represents the XML schema to base the <see cref="T:System.Data.DataSet" /> on.</param> + <param name="tableName"> + <attribution license="cc4" from="Microsoft" modified="false" />A string that represents the name of the table to return the provider name from.</param> </Docs> </Member> <Member MemberName="ReferencedAssemblies"> @@ -218,10 +296,16 @@ <ReturnType>System.Collections.Generic.ICollection<System.Reflection.Assembly></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The generator iterates over this list and adds the assemblies to your project.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the collection of assemblies referenced in a typed dataset.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetGeneratorException.xml b/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetGeneratorException.xml index 4417d854bae..5582546a98e 100644 --- a/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetGeneratorException.xml +++ b/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetGeneratorException.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TypedDataSetGeneratorException" FullName="System.Data.Design.TypedDataSetGeneratorException"> <TypeSignature Language="C#" Value="public class TypedDataSetGeneratorException : System.Data.DataException" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class indicates that a conflict occurred while an attempt is being made to generate a typed dataset class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The exception that is thrown when a name conflict occurs while a strongly typed <see cref="T:System.Data.DataSet" /> is being generated.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +28,48 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor initializes the <see cref="P:System.Exception.Message" /> property of the new instance to a system-supplied message that describes the error, such as "DefaultMessageDisplayedByParameterlessCtorWriterMustSupply" This message takes into account the current system culture.</para> + <para>The following table shows the initial property values for an instance of <see cref="T:System.InsufficientMemoryException" />.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Property </para> + </term> + <description> + <para>Value </para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="P:System.Exception.InnerException" /> + </para> + </term> + <description> + <para>null.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Exception.Message" /> + </para> + </term> + <description> + <para>The localized error message string. </para> + </description> + </item> + </list> + <para>The <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class indicates that a conflict occurred while an attempt is being made to generate a typed dataset class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class with a system-supplied message that describes the error.</para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -35,9 +82,16 @@ <Parameter Name="list" Type="System.Collections.IList" /> </Parameters> <Docs> - <param name="list">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class indicates that a conflict occurred while an attempt is being made to generate a typed dataset class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class by passing in a collection of errors.</para> + </summary> + <param name="list"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IList" /> of errors.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -51,8 +105,47 @@ </Parameters> <Docs> <param name="error">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The following table shows the initial property values for an instance of <see cref="T:System.Data.Design.TypedDataSetGeneratorException" />.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Property </para> + </term> + <description> + <para>Value </para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="P:System.Exception.InnerException" /> + </para> + </term> + <description> + <para>null.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Exception.Message" /> + </para> + </term> + <description> + <para>The error message string specified in <paramref name="message" />. </para> + </description> + </item> + </list> + <para>The <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class indicates that a conflict occurred while an attempt is being made to generate a typed dataset class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class with a specified message that describes the error.</para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -66,10 +159,18 @@ <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see <format type="text/html"><a href="832AC524-21BC-419A-A27B-CA8BFC45840F">XML and SOAP Serialization</a></format>.The <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class indicates that a conflict occurred while an attempt is being made to generate a typed dataset class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class, using the specified serialization information and streaming context.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Runtime.Serialization.StreamingContext" /> structure.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -85,8 +186,48 @@ <Docs> <param name="error">To be added.</param> <param name="inner">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An exception that is thrown as a direct result of a previous exception should include a reference to the previous exception in the <see cref="P:System.Exception.InnerException" /> property. The <see cref="P:System.Exception.InnerException" /> property returns the same value that is passed into the constructor, or null if the <see cref="P:System.Exception.InnerException" /> property does not supply the inner exception value to the constructor.</para> + <para>The following table shows the initial property values for an instance of <see cref="T:System.Data.Design.TypedDataSetGeneratorException" />.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Property </para> + </term> + <description> + <para>Value </para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="P:System.Exception.InnerException" /> + </para> + </term> + <description> + <para>null. </para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Exception.Message" /> + </para> + </term> + <description> + <para>The error message string specified in <paramref name="message" />. </para> + </description> + </item> + </list> + <para>The <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class indicates that a conflict occurred while an attempt is being made to generate a typed dataset class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class with the specified string and inner exception.</para> + </summary> </Docs> </Member> <Member MemberName="ErrorList"> @@ -99,9 +240,15 @@ <ReturnType>System.Collections.IList</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class indicates that a conflict occurred while an attempt is being made to generate a typed dataset class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a dynamic list of generated errors.</para> + </summary> </Docs> </Member> <Member MemberName="GetObjectData"> @@ -119,10 +266,17 @@ </Parameters> <Docs> <param name="si">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see <format type="text/html"><a href="832AC524-21BC-419A-A27B-CA8BFC45840F">XML and SOAP Serialization</a></format>. The <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> class indicates that a conflict occurred while an attempt is being made to generate a typed dataset class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implements the ISerializable interface and returns the data that you must have to serialize the <see cref="T:System.Data.Design.TypedDataSetGeneratorException" /> object.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Runtime.Serialization.StreamingContext" /> structure.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetSchemaImporterExtension.xml b/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetSchemaImporterExtension.xml index 99eea215f5e..1d49cab94f6 100644 --- a/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetSchemaImporterExtension.xml +++ b/mcs/class/System.Design/Documentation/en/System.Data.Design/TypedDataSetSchemaImporterExtension.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TypedDataSetSchemaImporterExtension" FullName="System.Data.Design.TypedDataSetSchemaImporterExtension"> <TypeSignature Language="C#" Value="public class TypedDataSetSchemaImporterExtension : System.Xml.Serialization.Advanced.SchemaImporterExtension" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Expands upon the <see cref="T:System.Xml.Serialization.XmlSchemaImporter" /> to provide additional functionality for typed datasets.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +28,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Expands upon the <see cref="T:System.Xml.Serialization.XmlSchemaImporter" /> to provide additional functionality for typed datasets and generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Data.Design.TypedDataSetSchemaImporterExtension" /> class.</para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -60,17 +73,34 @@ <Parameter Name="codeProvider" Type="System.CodeDom.Compiler.CodeDomProvider" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <param name="context">To be added.</param> - <param name="schemas">To be added.</param> - <param name="importer">To be added.</param> - <param name="compileUnit">To be added.</param> - <param name="mainNamespace">To be added.</param> - <param name="options">To be added.</param> - <param name="codeProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para> + </block> + <para>Expands upon the <see cref="T:System.Xml.Serialization.XmlSchemaImporter" /> to provide additional functionality for typed datasets and generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates internal type mapping information for an element defined in an XML schema document.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />XMLSchemaType</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.Schema.XmlSchemaObject" /> that represents the root class for the Xml schema object model hierarchy and serves as a base class for classes such as the XmlSchema class.</param> + <param name="schemas"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.Schema.XmlSchema" /> class that represents a collection of XML schemas.</param> + <param name="importer"> + <attribution license="cc4" from="Microsoft" modified="false" />The base <see cref="T:System.Xml.Serialization.XmlSchemaImporter" /> that generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document.</param> + <param name="compileUnit"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeCompileUnit" /> to contain the generated code.</param> + <param name="mainNamespace"> + <attribution license="cc4" from="Microsoft" modified="false" />CodeNamespace</param> + <param name="options"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.Serialization.CodeGenerationOptions" /> that specifies various options to use when generating .NET Framework types for use with an XML Web service.</param> + <param name="codeProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The language specific <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> to use to generate the dataset.</param> </Docs> </Member> <Member MemberName="ImportSchemaType"> @@ -94,19 +124,37 @@ <Parameter Name="codeProvider" Type="System.CodeDom.Compiler.CodeDomProvider" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="namespaceName">To be added.</param> - <param name="context">To be added.</param> - <param name="schemas">To be added.</param> - <param name="importer">To be added.</param> - <param name="compileUnit">To be added.</param> - <param name="mainNamespace">To be added.</param> - <param name="options">To be added.</param> - <param name="codeProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para> + </block> + <para>Expands upon the <see cref="T:System.Xml.Serialization.XmlSchemaImporter" /> to provide additional functionality for typed datasets and generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates internal type mapping information for an element defined in an XML schema document.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> representing the name of the schema to import.</param> + <param name="namespaceName"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> representing the namespace of the XML schema.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.Schema.XmlSchemaObject" /> that represents the root class for the XML schema object model hierarchy and serves as a base class for classes such as the XmlSchema class.</param> + <param name="schemas"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Xml.Schema.XmlSchema" /> class that represents a collection of XML schemas.</param> + <param name="importer"> + <attribution license="cc4" from="Microsoft" modified="false" />The base <see cref="T:System.Xml.Serialization.XmlSchemaImporter" /> that generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document.</param> + <param name="compileUnit"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeCompileUnit" /> to contain the generated code.</param> + <param name="mainNamespace"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.CodeDom.CodeNamespace" /> that contains the generated dataset.</param> + <param name="options"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.Serialization.CodeGenerationOptions" /> that specifies various options to use when generating .NET Framework types for use with an XML Web service.</param> + <param name="codeProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The language specific <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> to use to generate the dataset.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/LogConverter.xml b/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/LogConverter.xml index 74f354ce0f1..d17f453f167 100644 --- a/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/LogConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/LogConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="LogConverter" FullName="System.Diagnostics.Design.LogConverter"> <TypeSignature Language="C#" Value="public class LogConverter : System.ComponentModel.TypeConverter" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Diagnostics.Design.LogConverter" /> converts object references to and from other representations.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides the type converter for the <see cref="P:System.Diagnostics.EventLog.Log" /> property.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Diagnostics.Design.LogConverter" /> class for the given type.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,11 +49,16 @@ <Parameter Name="sourceType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="sourceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether this converter can convert an object of the given type to the type of this converter, using the specified context. </para> + </summary> + <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 T:System.Type that represents the type you want to convert from.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,12 +77,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the given object to a string, using the specified context and culture information.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An T:System.ComponentModel.ITypeDescriptorContext that provides a format context.</param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />The T:System.Globalization.CultureInfo to use as the current culture.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The T:System.Object to convert</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -83,10 +105,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <paramref name="context" /> parameter can be used to extract additional information about the environment this converter is being invoked from. This can be null, so always check. Also, properties on the context object can return null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of standard values for the data type this validator is designed for.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -103,10 +132,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <paramref name="context" /> parameter can be used to extract additional information about the environment this converter is being invoked from. This can be null, so always check. Also, properties on the context object can return null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether this object supports a standard set of values that can be picked from a list using the specified context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -114,4 +150,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessDesigner.xml index cbc56bcad98..2574faf2a9a 100644 --- a/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ProcessDesigner" FullName="System.Diagnostics.Design.ProcessDesigner"> <TypeSignature Language="C#" Value="public class ProcessDesigner : System.ComponentModel.Design.ComponentDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Base designer class for extending the design-mode behavior of a process.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Diagnostics.Design.ProcessDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,9 +44,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method adds the nonbrowsable "EnableRaisingEvents" and "StartInfo" properties to the designer's process at design time. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adjusts the set of properties the process exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> containing the properties for the class of the component.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -47,4 +61,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessModuleDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessModuleDesigner.xml index 1c9679285f0..5c83f0eb0d1 100644 --- a/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessModuleDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessModuleDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ProcessModuleDesigner" FullName="System.Diagnostics.Design.ProcessModuleDesigner"> <TypeSignature Language="C#" Value="public class ProcessModuleDesigner : System.ComponentModel.Design.ComponentDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Base designer class for extending the design-mode behavior of a process module.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Diagnostics.Design.ProcessModuleDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,9 +44,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method adds the nonbrowsable "FileVersionInfo" property to the designer's process module at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adjusts the set of properties the process module exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> containing the properties for the class of the component.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -47,4 +61,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessThreadDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessThreadDesigner.xml index 9236dd5d265..51cb9681888 100644 --- a/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessThreadDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Diagnostics.Design/ProcessThreadDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ProcessThreadDesigner" FullName="System.Diagnostics.Design.ProcessThreadDesigner"> <TypeSignature Language="C#" Value="public class ProcessThreadDesigner : System.ComponentModel.Design.ComponentDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Base designer class for extending the design-mode behavior of a process thread.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Diagnostics.Design.ProcessThreadDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,9 +44,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method adds the nonbrowsable "IdealProcessor" and "ProcessorAffinity" properties to the designer's process thread at design time. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adjusts the set of properties the component exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> containing the properties for the class of the component.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -47,4 +61,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Messaging.Design/MessageDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Messaging.Design/MessageDesigner.xml index 3b2e24036ec..98f24688d0b 100644 --- a/mcs/class/System.Design/Documentation/en/System.Messaging.Design/MessageDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Messaging.Design/MessageDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MessageDesigner" FullName="System.Messaging.Design.MessageDesigner"> <TypeSignature Language="C#" Value="public class MessageDesigner : System.ComponentModel.Design.ComponentDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides basic design-time functionality for the <see cref="T:System.Messaging.Message" /> class.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Messaging.Design.MessageDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,9 +44,13 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Modifies the set of properties that the designer exposes through the <see cref="T:System.ComponentModel.TypeDescriptor" /> class.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.IDictionary" /> that contains the set of properties to filter for the component.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -47,4 +58,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Resources.Tools/StronglyTypedResourceBuilder.xml b/mcs/class/System.Design/Documentation/en/System.Resources.Tools/StronglyTypedResourceBuilder.xml index c73462f0ac1..18bf330d0cd 100644 --- a/mcs/class/System.Design/Documentation/en/System.Resources.Tools/StronglyTypedResourceBuilder.xml +++ b/mcs/class/System.Design/Documentation/en/System.Resources.Tools/StronglyTypedResourceBuilder.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="StronglyTypedResourceBuilder" FullName="System.Resources.Tools.StronglyTypedResourceBuilder"> <TypeSignature Language="C#" Value="public static class StronglyTypedResourceBuilder" /> <AssemblyInfo> @@ -9,8 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Typically, resources separate code from content within an application. Creating and consuming these resources makes it easier to develop localizable applications. In the .NET Framework, resources are usually consumed by using the <see cref="T:System.Resources.ResourceManager" /> class, which contains methods that provide access to culture-specific resources at run time. For more information about creating and consuming resources, see <format type="text/html"><a href="8ad495d4-2941-40cf-bf64-e82e85825890">Resources in Applications</a></format>.</para> + <para>Strongly typed resource support is a compile-time feature that encapsulates access to resources by creating classes that contain a set of static, read-only (get) properties. This provides an alternative way to consume resources instead of calling the <see cref="Overload:System.Resources.ResourceManager.GetString" /> and <see cref="Overload:System.Resources.ResourceManager.GetObject" /> methods. </para> + <para>The basic functionality for strongly typed resource support is provided by the <see cref="T:System.Resources.Tools.StronglyTypedResourceBuilder" /> class (as well as the /str command-line option in the <format type="text/html"><a href="8ef159de-b660-4bec-9213-c3fbc4d1c6f4">Resource File Generator (Resgen.exe)</a></format>). The output of the <see cref="Overload:System.Resources.Tools.StronglyTypedResourceBuilder.Create" /> method is a class that contains strongly typed properties that match the resources that are referenced in the input parameter. This class provides read-only access to the resources that are available in the file processed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides support for strongly typed resources. This class cannot be inherited. </para> + </summary> </Docs> <Members> <Member MemberName="Create"> @@ -147,12 +156,25 @@ <Parameter Name="provider" Type="System.CodeDom.Compiler.CodeDomProvider" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <param name="provider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <paramref name="key" /> parameter is a valid string of characters, that string is returned. If the <paramref name="key" /> parameter is an invalid string or a string that contains invalid characters, the <see cref="M:System.Resources.Tools.StronglyTypedResourceBuilder.VerifyResourceName(System.String,System.CodeDom.Compiler.CodeDomProvider)" /> method attempts to generate a valid string based on the <paramref name="key" /> and <paramref name="provider" /> parameters. If a valid string can be generated, that string is returned; otherwise, null is returned.</para> + <para>If the <paramref name="key" /> parameter is an empty string (""), a string that consists of a single underscore character (_) is returned. If the <paramref name="key" /> parameter is not an empty string, the <see cref="M:System.Resources.Tools.StronglyTypedResourceBuilder.VerifyResourceName(System.String,System.CodeDom.Compiler.CodeDomProvider)" /> method compares each character in the string to a set of invalid tokens based on the language specified by the <paramref name="provider" /> parameter. Any invalid character in the string is replaced with an underscore character. The characters that will be replaced with an underscore are as follows:</para> + <para>' ' (space), U+00A0 (non-breaking space), '.' (period), ',' (comma), ';' (semicolon), '|', '~', '@', '#', '%', '^', '&', '*', '+', '-', '/', '\', '<', '>', '?', '[', ']', '(', ')', '{', '}', '"' (quote), ''' (apostrophe), ':', and '!'.</para> + <block subset="none" type="note"> + <para>Strongly typed resources do not allow the use of language keywords (such as if, for, and so on) as resource key names. However, the <see cref="N:System.CodeDom" /> design pattern allows the use of language keywords by prefixing the keyword with the underscore character. The <see cref="M:System.Resources.Tools.StronglyTypedResourceBuilder.VerifyResourceName(System.String,System.CodeDom.Compiler.CodeDomProvider)" /> method calls the <see cref="M:System.CodeDom.Compiler.ICodeGenerator.CreateValidIdentifier(System.String)" /> method to enforce this design. For example, if you use a resource name that is the same as a language keyword, such as for, the name appears as _for in the generated strongly typed resource class.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a valid resource string based on the specified input string and code provider.</para> + </summary> + <param name="key"> + <attribution license="cc4" from="Microsoft" modified="false" />The string to verify and, if necessary, convert to a valid resource name.</param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.CodeDom.Compiler.CodeDomProvider" /> object that specifies the target language to use.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.ServiceProcess.Design/ServiceControllerDesigner.xml b/mcs/class/System.Design/Documentation/en/System.ServiceProcess.Design/ServiceControllerDesigner.xml index e16831d2fe9..d51b284e9d9 100644 --- a/mcs/class/System.Design/Documentation/en/System.ServiceProcess.Design/ServiceControllerDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.ServiceProcess.Design/ServiceControllerDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ServiceControllerDesigner" FullName="System.ServiceProcess.Design.ServiceControllerDesigner"> <TypeSignature Language="C#" Value="public class ServiceControllerDesigner : System.ComponentModel.Design.ComponentDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time services for the <see cref="T:System.ServiceProcess.ServiceController" /> class.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ServiceProcess.Design.ServiceControllerDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,9 +44,13 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adjusts the set of properties the <see cref="T:System.ServiceProcess.ServiceController" /> exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> containing the properties for the <see cref="T:System.ServiceProcess.ServiceController" /> class. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -47,4 +58,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/AdRotatorDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/AdRotatorDesigner.xml index 50c697f1492..7df68e95473 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/AdRotatorDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/AdRotatorDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="AdRotatorDesigner" FullName="System.Web.UI.Design.WebControls.AdRotatorDesigner"> <TypeSignature Language="C#" Value="public class AdRotatorDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>In a visual designer, when you switch from source view to design view, the markup that describes the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control is parsed. A design-time version of the control is created on the design surface. When you switch back to source view, the design-time control code is persisted to the markup for the Web page. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a visual designer for the <see cref="T:System.Web.UI.WebControls.AdRotator" /> control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.AdRotatorDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -35,9 +45,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates the markup that is used to render the control on the design surface.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -45,4 +58,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataBoundControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataBoundControlDesigner.xml index 08c6c0690b5..13c903dd0fa 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataBoundControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataBoundControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BaseDataBoundControlDesigner" FullName="System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner"> <TypeSignature Language="C#" Value="public abstract class BaseDataBoundControlDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>In a visual designer, when you switch from Source to Design view, the markup that describes a control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> class is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control code is persisted to the markup source and edited into the markup for the Web page. </para> + <para>Designers that are derived from the <see cref="T:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner" /> abstract base class provide design-time support for controls that are derived from the <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a visual designer for controls that are derived from the <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> class.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +29,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of a designer that is derived from the <see cref="T:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner" /> class when it creates the associated control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="ConnectToDataSource"> @@ -36,9 +50,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The implementation of the <see cref="M:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.ConnectToDataSource" /> method typically involves unhooking events from the previous data source, and then attaching new events to the new data source.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, typically unhooks events from the previous data source, and then attaches new events to the new data source. </para> + </summary> </Docs> </Member> <Member MemberName="CreateDataSource"> @@ -52,8 +72,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, creates a new data source for the associated <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> object.</para> + </summary> </Docs> </Member> <Member MemberName="DataBind"> @@ -69,9 +92,16 @@ <Parameter Name="dataBoundControl" Type="System.Web.UI.WebControls.BaseDataBoundControl" /> </Parameters> <Docs> - <param name="dataBoundControl">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When you override the <see cref="M:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.DataBind(System.Web.UI.WebControls.BaseDataBoundControl)" /> method in a designer that is derived from the <see cref="T:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner" /> class, perform the necessary actions to set up the data-bound control so that when the design-time markup is retrieved, the control renders properly. Typically, you will associate a design-time data source rather than the live data source, for performance reasons.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, performs the necessary actions to set up the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> class.</para> + </summary> + <param name="dataBoundControl"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> with which this designer is associated.</param> </Docs> </Member> <Member MemberName="DataSource"> @@ -84,9 +114,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.DataSource" /> property is used to shadow the <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSource" /> property of the <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> class that is associated with this designer. The value of the <see cref="P:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.DataSource" /> property is persisted by the designer as a data-binding expression on the tag that is generated for the underlying <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the value of the <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSource" /> property for the associated control.</para> + </summary> </Docs> </Member> <Member MemberName="DataSourceID"> @@ -99,9 +135,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.DataSourceID" /> property is used to shadow the <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSourceID" /> property of the underlying <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the value of the <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSourceID" /> property of the underlying <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> object.</para> + </summary> </Docs> </Member> <Member MemberName="DisconnectFromDataSource"> @@ -115,8 +157,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, unhooks events from the current data source. </para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -132,9 +177,16 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.Dispose(System.Boolean)" /> method unhooks the event handlers for the designer from all data source events.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources that are used by the <see cref="T:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner" /> object, and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param> </Docs> </Member> <Member MemberName="GetDesignTimeHtml"> @@ -148,9 +200,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner" /> class retrieves sample data that is used for binding purposes at design time before rendering the control. If the control is not data bound, it calls the <see cref="M:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.GetEmptyDesignTimeHtml" /> method. If there is an error rendering the control, it calls the <see cref="M:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.GetErrorDesignTimeHtml(System.Exception)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates the markup that is used to render the control at design time. </para> + </summary> </Docs> </Member> <Member MemberName="GetEmptyDesignTimeHtml"> @@ -164,9 +222,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner" /> class retrieves sample data that is used for binding purposes at design time before rendering the control. The empty design-time control renders as a placeholder that contains the type name and control name.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides the markup that is used to render the control at design time if the control is empty or if the data source cannot be retrieved. </para> + </summary> </Docs> </Member> <Member MemberName="GetErrorDesignTimeHtml"> @@ -182,10 +246,17 @@ <Parameter Name="e" Type="System.Exception" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The error design-time control renders as a placeholder that contains the type name, the control name, and a message describing the error.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides the markup that is used to render the control at design time when an error has occurred.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Exception" /> that was thrown.</param> </Docs> </Member> <Member MemberName="Initialize"> @@ -201,9 +272,16 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The designer host calls the <see cref="M:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.Initialize(System.ComponentModel.IComponent)" /> method when it is ready to use the designer to render a control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> class. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.Initialize(System.ComponentModel.IComponent)" /> method and its base methods configure properties and connect events that are necessary for the operation of the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Prepares the designer to view, edit, and design the associated control.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />A control derived from <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" />, which implements <see cref="T:System.ComponentModel.IComponent" />.</param> </Docs> </Member> <Member MemberName="OnDataSourceChanged"> @@ -219,9 +297,16 @@ <Parameter Name="forceUpdateView" Type="System.Boolean" /> </Parameters> <Docs> - <param name="forceUpdateView">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.OnDataSourceChanged(System.Boolean)" /> method connects to the current data source. If the current data source is different from the data source to which the control was previously connected, or <paramref name="forceUpdateView" /> is true, the associated control is redrawn on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the data source of the associated <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> object changes. </para> + </summary> + <param name="forceUpdateView"> + <attribution license="cc4" from="Microsoft" modified="false" />true to force the update of design-time markup; otherwise, false.</param> </Docs> </Member> <Member MemberName="OnSchemaRefreshed"> @@ -235,8 +320,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.DetailsViewDesigner.OnSchemaRefreshed" /> method handles the <see cref="E:System.Web.UI.Design.IDataSourceDesigner.SchemaRefreshed" /> event, which is raised when the schema of the data source to which the associated control is bound changes. Override the <see cref="M:System.Web.UI.Design.WebControls.DetailsViewDesigner.OnSchemaRefreshed" /> method to perform additional actions that are required when new schema is available.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the data source of the associated <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> object loads a new schema. </para> + </summary> </Docs> </Member> <Member MemberName="PreFilterProperties"> @@ -252,9 +343,17 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Control designers use methods that are derived from the <see cref="M:System.ComponentModel.Design.ComponentDesigner.PreFilterProperties(System.Collections.IDictionary)" /> method to shadow various control properties with corresponding design-time properties that the designer implements, and to add or remove properties from the <ui>Properties</ui> grid.</para> + <para>For the <see cref="T:System.Web.UI.WebControls.BaseDataBoundControl" /> class, the <see cref="M:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.PreFilterProperties(System.Collections.IDictionary)" /> shadows the <see cref="P:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.DataSource" /> property of the control. It makes a copy of the attribute array of the <see cref="P:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.DataSource" />, and then adds these attributes to the shadowed property. It sets the <see cref="P:System.ComponentModel.BrowsableAttribute.Browsable" /> attribute of the shadowed <see cref="P:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.DataSource" /> property to false unless the <see cref="P:System.ComponentModel.BrowsableAttribute.Browsable" /> attribute of the <see cref="P:System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner.DataSourceID" /> property of the control is already set to true.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Used by the designer to remove or add additional properties for display in the <ui>Properties</ui> grid or to shadow properties of the associated control.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Collections.IDictionary" /> containing the properties to filter.</param> </Docs> </Member> <Member MemberName="ShowCreateDataSourceDialog"> @@ -283,4 +382,4 @@ </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataListComponentEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataListComponentEditor.xml index fe66df9b2e6..accf497f9bf 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataListComponentEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataListComponentEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BaseDataListComponentEditor" FullName="System.Web.UI.Design.WebControls.BaseDataListComponentEditor"> <TypeSignature Language="C#" Value="public abstract class BaseDataListComponentEditor : System.Windows.Forms.Design.WindowsFormsComponentEditor" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A component editor provides a user interface for editing the properties of a control. Component editors are invoked from control designers by using the <ui>Property Builder</ui> menu item from the context menu on the control. Component editors that are derived from the <see cref="T:System.Web.UI.Design.WebControls.BaseDataListComponentEditor" /> class are invoked from designers derived from the <see cref="T:System.Web.UI.Design.WebControls.BaseDataListDesigner" /> class, and are used to edit the properties of controls that are derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class. For examples of such controls, see <see cref="T:System.Web.UI.WebControls.DataGrid" /> and <see cref="T:System.Web.UI.WebControls.DataList" />.</para> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListComponentEditor.EditComponent(System.ComponentModel.ITypeDescriptorContext,System.Object,System.Windows.Forms.IWin32Window)" /> method displays a component editor for the associated control, if one can be created. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListComponentEditor.GetInitialComponentEditorPageIndex" /> method returns the index of the initial page to be displayed in the component editor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a component editor base class for Web server controls that are derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -22,8 +30,14 @@ </Parameters> <Docs> <param name="initial_page">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A designer that is derived from the <see cref="T:System.Web.UI.Design.WebControls.BaseDataListDesigner" /> class creates a component editor that is derived from the <see cref="T:System.Web.UI.Design.WebControls.BaseDataListComponentEditor" /> class, when the user selects <ui>Property Builder</ui> from the context menu within the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.BaseDataListComponentEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -42,12 +56,21 @@ <Parameter Name="parent" Type="System.Windows.Forms.IWin32Window" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="obj">To be added.</param> - <param name="parent">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.Web.UI.Design.WebControls.BaseDataListComponentEditor.EditComponent" /> method gets a <see cref="T:System.Type" /> array of page control types by using the <see cref="M:System.Windows.Forms.Design.WindowsFormsComponentEditor.GetComponentEditorPages" /> method. It creates a <see cref="T:System.Windows.Forms.Design.ComponentEditorForm" /> object, and then calls its <see cref="M:System.Windows.Forms.Design.ComponentEditorForm.ShowForm" /> method to display the component editor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the specified component by using the specified context descriptor and parent window.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information. </param> + <param name="obj"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> implementing the <see cref="T:System.ComponentModel.IComponent" />, which represents the component to edit. </param> + <param name="parent"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.IWin32Window" /> that represents the parent window. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -62,9 +85,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The initial page is specified when the <see cref="T:System.Web.UI.Design.WebControls.BaseDataListComponentEditor" /> object is created. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the index of the initial page to display in the component editor.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -72,4 +101,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataListDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataListDesigner.xml index 28e601a2eb2..80418019bfa 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataListDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseDataListDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BaseDataListDesigner" FullName="System.Web.UI.Design.WebControls.BaseDataListDesigner"> <TypeSignature Language="C#" Value="public abstract class BaseDataListDesigner : System.Web.UI.Design.TemplatedControlDesigner, System.Web.UI.Design.IDataSourceProvider" /> <AssemblyInfo> @@ -14,8 +15,39 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>In a designer host, when the user switches from Source to Design view, the markup source code that describes a control derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> abstract class is parsed and a design-time version of the control is created on the design surface. When the user switches back to Source view, the design-time control is persisted to markup source code and edited into the markup for the Web page. The <see cref="T:System.Web.UI.Design.WebControls.BaseDataListDesigner" /> abstract class serves as a base class for components that provide design-time support for controls that are derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> in a designer host.</para> + <para>The <see cref="T:System.Web.UI.Design.WebControls.BaseDataListDesigner" /> class properties provide the following functionality:</para> + <para>The <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.ActionLists" /> property returns a <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> object, which typically contains an object that is derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class for each level in the inheritance tree of the designer. </para> + <list type="bullet"> + <item> + <para>The <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DataKeyField" />, <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DataMember" />, <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DataSource" />, and <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DataSourceID" /> properties provide access to the corresponding properties of the associated control. </para> + </item> + <item> + <para>The <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DataSourceDesigner" /> property provides access to the designer of the data source of the associated control. The <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DesignerView" /> property gets the default view of the data source. </para> + </item> + </list> + <para>The <see cref="T:System.Web.UI.Design.WebControls.BaseDataListDesigner" /> class methods provide the following functionality:</para> + <list type="bullet"> + <item> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.Initialize(System.ComponentModel.IComponent)" /> method prepares the designer to view, edit, and design the associated control. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.InvokePropertyBuilder(System.Int32)" /> method invokes a component editor for the control. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.PreFilterProperties(System.Collections.IDictionary)" /> method is used to add, remove, or shadow design-time properties of the associated control.</para> + </item> + <item> + <para>The <see cref="Overload:System.Web.UI.Design.WebControls.BaseDataListDesigner.GetDesignTimeDataSource" /> method generates an object that can be used as a data source at design time. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.GetSelectedDataSource" /> method gets the data source from the container of the associated control. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.GetResolvedSelectedDataSource" /> method gets the data source from the control container, resolved to a specific data member. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.GetTemplateContainerDataSource(System.String)" /> method gets the data source of the template container.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnComponentChanged(System.Object,System.ComponentModel.Design.ComponentChangedEventArgs)" /> method is called when there is a change to the associated control. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnDataSourceChanged" /> method is called when the associated control data source has changed. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnSchemaRefreshed" /> method is called when the schema of the associated control data source changes. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnAutoFormatApplied(System.Web.UI.Design.DesignerAutoFormat)" /> method is called when an automatic formatting scheme has been applied.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnStylesChanged" /> and <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnTemplateEditingVerbsChanged" /> methods can be overridden to implement functionality that should occur when an associated control style has changed or when the designer template-editing verbs have changed, respectively. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnPropertyBuilder(System.Object,System.EventArgs)" /> method handles the property-builder event. </para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base class for components that provide design-time support in a designer host for Web server controls that are derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,8 +55,14 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.Design.WebControls.BaseDataListDesigner" /> class when it creates the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class or a copy of that control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.BaseDataListDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,9 +76,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DataKeyField" /> property provides access from the designer to the <see cref="P:System.Web.UI.WebControls.BaseDataList.DataKeyField" /> property of the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class. The <see cref="P:System.Web.UI.WebControls.BaseDataList.DataKeyField" /> indicates the primary key of the data source that is bound to the associated control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the value of the data key field of the associated control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -54,9 +98,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DataMember" /> property provides access from the designer to the <see cref="P:System.Web.UI.WebControls.BaseDataList.DataMember" /> property of the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class. The <see cref="P:System.Web.UI.WebControls.BaseDataList.DataMember" /> indicates the table or element of the data source that is bound to the associated control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the value of the data member field of the associated control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -70,9 +120,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DataSource" /> property provides access from the designer to the <see cref="P:System.Web.UI.WebControls.BaseDataList.DataSource" /> property of the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the value of the data source property of the associated control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -105,9 +161,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class has a <see cref="P:System.ComponentModel.IComponent.Site" /> property that implements the <see cref="T:System.ComponentModel.Design.IDesignerHost" /> interface, the <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.Dispose(System.Boolean)" /> method disconnects the <see cref="E:System.ComponentModel.Design.IDesignerHost.LoadComplete" /> event of the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> object. </para> + <para>If the <see cref="P:System.ComponentModel.IComponent.Site" /> implements the <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> method, the <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.Dispose(System.Boolean)" /> disconnects the <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentAdded" />, <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoving" />, and <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoved" /> events. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.Dispose(System.Boolean)" /> also disconnects the <see cref="E:System.Web.UI.Design.DataSourceDesigner.DataSourceChanged" /> and <see cref="E:System.Web.UI.Design.DataSourceDesigner.SchemaRefreshed" /> events of the <see cref="T:System.Web.UI.Design.WebControls.BaseDataListDesigner" /> object. It finally calls the <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.Dispose(System.Boolean)" /> base method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources that are used by the designer and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -168,9 +232,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.GetSelectedDataSource" /> method uses the <see cref="M:System.Web.UI.Design.DesignTimeData.GetSelectedDataSource(System.ComponentModel.IComponent,System.String,System.String)" /> method to construct a data source from the object that is specified by the <see cref="P:System.Web.UI.WebControls.BaseDataList.DataSource" /> and <see cref="P:System.Web.UI.WebControls.BaseDataList.DataMember" /> properties of the associated control derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data source component from the associated control container, resolved to a specific data member.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -185,9 +255,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.GetSelectedDataSource" /> method uses the <see cref="M:System.Web.UI.Design.DesignTimeData.GetSelectedDataSource(System.ComponentModel.IComponent,System.String)" /> method to construct a data source from the object that is specified by the <see cref="P:System.Web.UI.WebControls.BaseDataList.DataSource" /> property of the associated control derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data source component from the associated control container.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -205,9 +281,15 @@ </Parameters> <Docs> <param name="template_name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.GetTemplateContainerDataSource(System.String)" /> method calls the <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.GetResolvedSelectedDataSource" /> method to construct a data source from the object that is specified by the <see cref="P:System.Web.UI.WebControls.BaseDataList.DataSource" /> and <see cref="P:System.Web.UI.WebControls.BaseDataList.DataMember" /> properties of the associated control derived from <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data source of the template's container.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -224,9 +306,18 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The designer host calls the <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.Initialize(System.ComponentModel.IComponent)" /> method when it is ready to use the designer to render the control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class. The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.Initialize(System.ComponentModel.IComponent)" /> method and its base methods configure properties and connect to events that are necessary for the operation of the designer.</para> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.Initialize(System.ComponentModel.IComponent)" /> connects to the design-time data source and updates the design-time markup. If the <see cref="P:System.ComponentModel.IComponent.Site" /> property implements the <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> interface, the <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.Initialize(System.ComponentModel.IComponent)" /> connects the <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentAdded" />, <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoving" />, and <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoved" /> events. </para> + <para>The <paramref name="component" /> parameter is the control, derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" />, that is associated with this designer, or a copy of that control. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Prepares the designer to view, edit, and design the associated control.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />A control derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" />, which implements an <see cref="T:System.ComponentModel.IComponent" />. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -248,8 +339,14 @@ </Parameters> <Docs> <param name="initial_page">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.InvokePropertyBuilder(System.Int32)" /> method creates a <see cref="T:System.Web.UI.Design.WebControls.DataGridComponentEditor" /> or <see cref="T:System.Web.UI.Design.WebControls.DataListComponentEditor" /> object, and then invokes the <see cref="M:System.Web.UI.Design.WebControls.BaseDataListComponentEditor.EditComponent(System.ComponentModel.ITypeDescriptorContext,System.Object,System.Windows.Forms.IWin32Window)" /> method of the component editor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Invokes a component editor for the associated control.</para> + </summary> </Docs> </Member> <Member MemberName="OnAutoFormat"> @@ -263,10 +360,18 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="sender">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnAutoFormat(System.Object,System.EventArgs)" /> method is obsolete and has no functionality.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Handles the AutoFormat event.</para> + </summary> + <param name="sender"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> that raised the event.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object that contains the event data. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -284,10 +389,18 @@ <Parameter Name="e" Type="System.ComponentModel.Design.ComponentChangedEventArgs" /> </Parameters> <Docs> - <param name="sender">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnComponentChanged(System.Object,System.ComponentModel.Design.ComponentChangedEventArgs)" /> method is called when the <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentChanged" /> event of a control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class executes. Typically, this is in response to a property change on the control (for example, a <ui>Properties</ui> grid change). If the <see cref="P:System.Web.UI.Design.WebControls.BaseDataListDesigner.DataSource" /> object to which the control is bound is changed, the control is redrawn on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when there is a change to the associated control.</para> + </summary> + <param name="sender"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> that is the source of the event.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.ComponentChangedEventArgs" /> that contains the event data.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -306,8 +419,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnDataSourceChanged" /> base method connects the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class to the current data source, and if that is different from the data source to which the control was connected, the method updates the design-time markup. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the data source for the associated control has changed.</para> + </summary> </Docs> </Member> <Member MemberName="OnPropertyBuilder"> @@ -321,10 +440,18 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="sender">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnPropertyBuilder(System.Object,System.EventArgs)" /> method invokes a component editor for the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class. It creates a <see cref="T:System.Web.UI.Design.WebControls.DataGridComponentEditor" /> or <see cref="T:System.Web.UI.Design.WebControls.DataListComponentEditor" /> object, and then invokes the <see cref="M:System.Web.UI.Design.WebControls.BaseDataListComponentEditor.EditComponent(System.ComponentModel.ITypeDescriptorContext,System.Object,System.Windows.Forms.IWin32Window)" /> method of the component editor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that handles the property-builder event.</para> + </summary> + <param name="sender"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> that is the source of the event. </param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object that contains the event data. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -343,8 +470,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnStylesChanged" /> method can serve as notification that a style of the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class has changed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Can be overridden to implement functionality that should occur when a style of the associated control has changed.</para> + </summary> </Docs> </Member> <Member MemberName="OnTemplateEditingVerbsChanged"> @@ -355,8 +488,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.OnTemplateEditingVerbsChanged" /> method can be implemented to perform additional processing, such recording that a change has occurred, when the template-editing verbs change.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Can be overridden to implement functionality that should occur when the designer template-editing verbs have changed.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -373,9 +512,17 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Control designers use methods that are derived from the <see cref="M:System.ComponentModel.Design.ComponentDesigner.PreFilterProperties(System.Collections.IDictionary)" /> method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the <ui>Properties</ui> grid.</para> + <para>For controls that are derived from the <see cref="T:System.Web.UI.WebControls.BaseDataList" /> class, the <see cref="M:System.Web.UI.Design.WebControls.BaseDataListDesigner.PreFilterProperties(System.Collections.IDictionary)" /> creates design-time properties to shadow the <see cref="P:System.Web.UI.WebControls.BaseDataList.DataSource" />, <see cref="P:System.Web.UI.WebControls.BaseDataList.DataMember" />, <see cref="P:System.Web.UI.WebControls.BaseDataList.DataKeyField" />, and <see cref="P:System.Web.UI.WebControls.BaseDataList.DataSourceID" /> properties.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Used by the designer to remove properties from or add additional properties to the display in the <ui>Properties</ui> grid or to shadow properties of the associated control. </para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection implementing an <see cref="T:System.Collections.IDictionary" /> interface of the added and shadowed properties. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -399,4 +546,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseValidatorDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseValidatorDesigner.xml index 04dfa56c3be..fcba77b14be 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseValidatorDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/BaseValidatorDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BaseValidatorDesigner" FullName="System.Web.UI.Design.WebControls.BaseValidatorDesigner"> <TypeSignature Language="C#" Value="public class BaseValidatorDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>In a visual designer, when you switch from Source to Design view, the markup source code that describes a control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseValidator" /> abstract class is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to markup source code and edited into the markup for the Web page. The <see cref="T:System.Web.UI.Design.WebControls.BaseValidatorDesigner" /> objects provide design-time support for controls that are derived from the <see cref="T:System.Web.UI.WebControls.BaseValidator" /> class in a visual designer.</para> + <para>The <see cref="M:System.Web.UI.Design.WebControls.BaseValidatorDesigner.GetDesignTimeHtml" /> method gets the markup that is used to render the associated control at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a visual designer for Web server controls that are derived from the <see cref="T:System.Web.UI.WebControls.BaseValidator" /> class. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,14 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.Design.WebControls.BaseValidatorDesigner" /> class when it creates the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseValidator" /> class or a copy of that control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.BaseValidatorDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -35,9 +49,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="P:System.Web.UI.WebControls.BaseValidator.ErrorMessage" /> or <see cref="P:System.Web.UI.WebControls.BaseValidator.Text" /> property of the associated control that is derived from the <see cref="T:System.Web.UI.WebControls.BaseValidator" /> class is an empty string (""), or if the <see cref="P:System.Web.UI.WebControls.BaseValidator.Display" /> property is set to the <see cref="F:System.Web.UI.WebControls.ValidatorDisplay.None" /> field, the <see cref="M:System.Web.UI.Design.WebControls.BaseValidatorDesigner.GetDesignTimeHtml" /> method sets the <see cref="P:System.Web.UI.WebControls.BaseValidator.ErrorMessage" /> property to the control ID, which is enclosed in brackets ([]) and sets the <see cref="P:System.Web.UI.WebControls.BaseValidator.Display" /> property to the <see cref="F:System.Web.UI.WebControls.ValidatorDisplay.Static" /> field. The <see cref="M:System.Web.UI.Design.WebControls.BaseValidatorDesigner.GetDesignTimeHtml" /> then calls the <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" /> base method to generate the markup, and restores the control properties to their original values, if necessary.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the markup that is used to render the associated control at design time. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -45,4 +65,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/ButtonDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/ButtonDesigner.xml index 537afbf29e2..701a505f847 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/ButtonDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/ButtonDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ButtonDesigner" FullName="System.Web.UI.Design.WebControls.ButtonDesigner"> <TypeSignature Language="C#" Value="public class ButtonDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>In a visual designer, when you switch from Source to Design view, the markup source code that describes the <see cref="T:System.Web.UI.WebControls.Button" /> control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Used to provide design-time support in a visual designer for the <see cref="T:System.Web.UI.WebControls.Button" /> Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,14 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.Design.WebControls.ButtonDesigner" /> class when it creates the associated <see cref="T:System.Web.UI.WebControls.Button" /> control or a copy of that control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.ButtonDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -35,9 +48,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.ButtonDesigner.GetDesignTimeHtml" /> method replaces the <see cref="P:System.Web.UI.WebControls.Button.Text" /> property with the <see cref="P:System.Web.UI.Control.ID" /> property of the <see cref="T:System.Web.UI.WebControls.Button" /> control if the <see cref="P:System.Web.UI.WebControls.Button.Text" /> contains no displayable characters. Then, the <see cref="M:System.Web.UI.Design.WebControls.ButtonDesigner.GetDesignTimeHtml" /> method calls its base method, <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" />, which calls into the <see cref="M:System.Web.UI.Control.RenderControl(System.Web.UI.HtmlTextWriter)" /> method to generate the markup.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the markup that is used to render the associated control at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -45,4 +64,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CalendarAutoFormatDialog.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CalendarAutoFormatDialog.xml index 4af57bf9891..912f2e0e980 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CalendarAutoFormatDialog.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CalendarAutoFormatDialog.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CalendarAutoFormatDialog" FullName="System.Web.UI.Design.WebControls.CalendarAutoFormatDialog"> <TypeSignature Language="C#" Value="public class CalendarAutoFormatDialog : System.Windows.Forms.Form" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an <ui>Auto Format</ui> dialog box for a <see cref="T:System.Web.UI.WebControls.Calendar" /> Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,9 +25,13 @@ <Parameter Name="calendar" Type="System.Web.UI.WebControls.Calendar" /> </Parameters> <Docs> - <param name="calendar">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new AutoFormatPage instance associated with a <see cref="T:System.Web.UI.WebControls.Calendar" /> instance for a designer host.</para> + </summary> + <param name="calendar"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.Calendar" /> instance for which the AutoFormatePage is displayed.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -41,10 +49,15 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="source">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the <see cref="T:System.Web.UI.Design.WebControls.CalendarAutoFormatDialog" /> is activated.</para> + </summary> + <param name="source"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event. </param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that provides information about the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -78,10 +91,15 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="source">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Handles changes in the pre-defined schema choices </para> + </summary> + <param name="source"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event. </param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that provides information about the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -99,10 +117,15 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="source">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Handles changes in the predefined schema choices </para> + </summary> + <param name="source"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event. </param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that provides information about the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -110,4 +133,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CalendarDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CalendarDesigner.xml index e2f7fe5ea34..7a1aebe0f48 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CalendarDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CalendarDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CalendarDesigner" FullName="System.Web.UI.Design.WebControls.CalendarDesigner"> <TypeSignature Language="C#" Value="public class CalendarDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends design-time behavior for the <see cref="T:System.Web.UI.WebControls.Calendar" /> Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.CalendarDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,9 +44,16 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The designer host calls <see cref="M:System.Web.UI.Design.WebControls.CalendarDesigner.Initialize(System.ComponentModel.IComponent)" /> to initialize the component for the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer with the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> object for this designer. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -57,10 +71,18 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="sender">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Schemes are applied by the user to set the appearance of a control from a collection of predefined styles. Override this method to perform other actions that might be needed after a scheme is applied to a control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when an auto-format scheme has been applied to the control.</para> + </summary> + <param name="sender"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event. </param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.EventArgs" /> object that contains the event data. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -74,9 +96,12 @@ <ReturnType>System.ComponentModel.Design.DesignerVerbCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the collection of verbs that are available to this designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -84,4 +109,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CheckBoxDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CheckBoxDesigner.xml index c4f91d5fb48..d52d9ba748f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CheckBoxDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/CheckBoxDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CheckBoxDesigner" FullName="System.Web.UI.Design.WebControls.CheckBoxDesigner"> <TypeSignature Language="C#" Value="public class CheckBoxDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.WebControls.CheckBoxDesigner" /> class overrides the <see cref="M:System.Web.UI.Design.WebControls.CheckBoxDesigner.GetDesignTimeHtml" /> method of the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class to ensure that the control is displayed with a meaningful representation at design time. If the <see cref="P:System.Web.UI.WebControls.CheckBox.Text" /> property is empty, the <see cref="M:System.Web.UI.Design.WebControls.CheckBoxDesigner.GetDesignTimeHtml" /> method of this class sets the <see cref="P:System.Web.UI.WebControls.CheckBox.Text" /> property of the control to the <see cref="P:System.Web.UI.Control.ID" /> property of the control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends design-time behavior for the <see cref="T:System.Web.UI.WebControls.CheckBox" /> Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.CheckBoxDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -35,9 +45,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="P:System.Web.UI.WebControls.Button.Text" /> property is empty or consists only of white space, then the generated HTML contains the <see cref="P:System.Web.UI.Control.ID" /> of the check box control; otherwise, the generated HTML contains the contents of the control's <see cref="P:System.Web.UI.WebControls.Button.Text" /> property.</para> + <para>Override this method to change the generated HTML. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the markup that is used to represent the control at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -45,4 +62,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataBoundControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataBoundControlDesigner.xml index 2f6774a742c..e082de7cf76 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataBoundControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataBoundControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataBoundControlDesigner" FullName="System.Web.UI.Design.WebControls.DataBoundControlDesigner"> <TypeSignature Language="C#" Value="public class DataBoundControlDesigner : System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner, System.Web.UI.Design.IDataBindingSchemaProvider, System.Web.UI.Design.IDataSourceProvider" /> <AssemblyInfo> @@ -16,8 +17,14 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extend the <see cref="T:System.Web.UI.Design.WebControls.DataBoundControlDesigner" /> class if you want to create a designer for the <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> Web server control or for a class that extends <see cref="T:System.Web.UI.WebControls.DataBoundControl" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base class for design-time support for controls that derive from <see cref="T:System.Web.UI.WebControls.DataBoundControl" />.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -28,8 +35,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.DataBoundControlDesigner" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="ActionLists"> @@ -42,9 +52,12 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> object for this designer.</para> + </summary> </Docs> </Member> <Member MemberName="ConnectToDataSource"> @@ -58,9 +71,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Disconnects events from the previous data source and connects them to the current data source.</para> + </summary> </Docs> </Member> <Member MemberName="CreateDataSource"> @@ -74,8 +90,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Invokes the standard dialog box to create a new data source control, and sets the new data source control's ID to the <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSourceID" /> property of the data-bound control.</para> + </summary> </Docs> </Member> <Member MemberName="DataBind"> @@ -91,9 +110,13 @@ <Parameter Name="dataBoundControl" Type="System.Web.UI.WebControls.BaseDataBoundControl" /> </Parameters> <Docs> - <param name="dataBoundControl">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Binds the <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> object to the data source.</para> + </summary> + <param name="dataBoundControl"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> object to bind to the data source.</param> </Docs> </Member> <Member MemberName="DataMember"> @@ -106,9 +129,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the shadowed <see cref="P:System.Web.UI.WebControls.DataBoundControl.DataMember" /> property of the underlying data-bound control.</para> + </summary> </Docs> </Member> <Member MemberName="DataSourceDesigner"> @@ -121,9 +147,12 @@ <ReturnType>System.Web.UI.Design.IDataSourceDesigner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the designer of the data source of the underlying data-bound control.</para> + </summary> </Docs> </Member> <Member MemberName="DesignerView"> @@ -136,9 +165,12 @@ <ReturnType>System.Web.UI.Design.DesignerDataSourceView</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Web.UI.Design.DesignerDataSourceView" /> object associated with the data source of this designer.</para> + </summary> </Docs> </Member> <Member MemberName="DisconnectFromDataSource"> @@ -152,8 +184,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Disconnects the data-bound control from data source events.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -169,9 +204,16 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.DataBoundControlDesigner.Dispose(System.Boolean)" /> method unregisters the designer's event handlers from all data source events.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.Web.UI.Design.WebControls.DataBoundControlDesigner" /> object and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param> </Docs> </Member> <Member MemberName="GetDesignTimeDataSource"> @@ -185,9 +227,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design-time data source from either the associated DataSourceDesigner or the DataSource property.</para> + </summary> </Docs> </Member> <Member MemberName="GetSampleDataSource"> @@ -201,9 +246,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets dummy sample data to render the data-bound control on the design surface if sample data cannot be created from the DataSourceDesigner or DataSource properties.</para> + </summary> </Docs> </Member> <Member MemberName="PreFilterProperties"> @@ -219,9 +267,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Override the <see cref="M:System.Web.UI.Design.WebControls.DataBoundControlDesigner.PreFilterProperties(System.Collections.IDictionary)" /> method to perform any additional actions required when the data source of the underlying data-bound control changes. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Overridden by the designer to shadow run-time properties of the data-bound control with corresponding properties implemented by the designer.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> object containing the properties to filter.</param> </Docs> </Member> <Member MemberName="SampleRowCount"> @@ -234,9 +289,12 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of rows that the data-bound control displays on the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="System.Web.UI.Design.IDataBindingSchemaProvider.CanRefreshSchema"> @@ -249,9 +307,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebControls.DataBoundControlDesigner" /> instance is cast to an <see cref="T:System.Web.UI.Design.IDataBindingSchemaProvider" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Web.UI.Design.IDataBindingSchemaProvider.CanRefreshSchema" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Web.UI.Design.IDataBindingSchemaProvider.RefreshSchema"> @@ -267,9 +331,16 @@ <Parameter Name="preferSilent" Type="System.Boolean" /> </Parameters> <Docs> - <param name="preferSilent">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebControls.DataBoundControlDesigner" /> instance is cast to an <see cref="T:System.Web.UI.Design.IDataBindingSchemaProvider" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Web.UI.Design.IDataBindingSchemaProvider.RefreshSchema(System.Boolean)" />. </para> + </summary> + <param name="preferSilent"> + <attribution license="cc4" from="Microsoft" modified="false" />Indicates whether to suppress any events raised while refreshing the schema.</param> </Docs> </Member> <Member MemberName="System.Web.UI.Design.IDataBindingSchemaProvider.Schema"> @@ -282,9 +353,15 @@ <ReturnType>System.Web.UI.Design.IDataSourceViewSchema</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebControls.DataBoundControlDesigner" /> instance is cast to an <see cref="T:System.Web.UI.Design.IDataBindingSchemaProvider" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Web.UI.Design.IDataBindingSchemaProvider.Schema" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Web.UI.Design.IDataSourceProvider.GetResolvedSelectedDataSource"> @@ -298,9 +375,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebControls.DataBoundControlDesigner" /> instance is cast to an <see cref="T:System.Web.UI.Design.IDataSourceProvider" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Web.UI.Design.IDataSourceProvider.GetResolvedSelectedDataSource" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Web.UI.Design.IDataSourceProvider.GetSelectedDataSource"> @@ -314,9 +397,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebControls.DataBoundControlDesigner" /> instance is cast to an <see cref="T:System.Web.UI.Design.IDataSourceProvider" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Web.UI.Design.IDataSourceProvider.GetSelectedDataSource" />.</para> + </summary> </Docs> </Member> <Member MemberName="UseDataSourcePickerActionList"> @@ -329,10 +418,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the designer should include "Choose a data source" in its action list.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataListComponentEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataListComponentEditor.xml index e0342834808..b7fc6450ce0 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataListComponentEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataListComponentEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataListComponentEditor" FullName="System.Web.UI.Design.WebControls.DataListComponentEditor"> <TypeSignature Language="C#" Value="public class DataListComponentEditor : System.Web.UI.Design.WebControls.BaseDataListComponentEditor" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A component editor provides a user interface (UI) for editing the properties of a control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a component editor for a <see cref="T:System.Web.UI.WebControls.DataList" /> control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.DataListComponentEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -35,8 +45,11 @@ </Parameters> <Docs> <param name="initial_page">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.DataListComponentEditor" /> class, and sets its initial page to the specified index.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -75,9 +88,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array of <see cref="T:System.Type" /> objects corresponding to the pages that can be edited using this editor.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -85,4 +101,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataProviderNameConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataProviderNameConverter.xml index f6c0c091161..20ba179710b 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataProviderNameConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/DataProviderNameConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataProviderNameConverter" FullName="System.Web.UI.Design.WebControls.DataProviderNameConverter"> <TypeSignature Language="C#" Value="public class DataProviderNameConverter : System.ComponentModel.StringConverter" /> <AssemblyInfo> @@ -9,9 +10,17 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.WebControls.DataProviderNameConverter" /> class is a <see cref="T:System.ComponentModel.TypeConverter" /> object that is typically referenced by the <see cref="T:System.ComponentModel.TypeConverterAttribute" /> attribute.</para> + <para>The names that are returned by the <see cref="M:System.Web.UI.Design.WebControls.DataProviderNameConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method are of ADO.NET providers, from the <see cref="M:System.Data.Common.DbProviderFactories.GetFactoryClasses" /> method, that create data objects.</para> + <para>The <see cref="M:System.Web.UI.Design.WebControls.DataProviderNameConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)" /> method gets a value indicating whether the returned provider names are an exclusive list of possible values. The <see cref="M:System.Web.UI.Design.WebControls.DataProviderNameConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)" /> method gets a value indicating whether the returned provider names are a standard set of values that can be picked from a list.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a user-selectable list of ActiveX® Data Objects (ADO) for the .NET Framework (ADO.NET) provider names. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +28,15 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.Design.WebControls.DataProviderNameConverter" /> class when the class is referenced by a <see cref="T:System.ComponentModel.TypeConverterAttribute" /> attribute. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.DataProviderNameConverter" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -37,11 +52,19 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.DataProviderNameConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method uses the <see cref="M:System.Data.Common.DbProviderFactories.GetFactoryClasses" /> method to return a <see cref="T:System.Data.DataTable" /> object containing the ADO.NET provider names. It converts this <see cref="T:System.Data.DataTable" /> to a string array, and then converts this array to a <see cref="T:System.ComponentModel.TypeConverter.StandardValuesCollection" /> object.</para> + <para>The <paramref name="context" /> parameter is not used by the <see cref="M:System.Web.UI.Design.WebControls.DataProviderNameConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a list of the available ActiveX® Data Objects (ADO) for the .NET Framework (ADO.NET) provider names.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An object implementing the <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides information about a context to a type converter so that the type converter can perform a conversion.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -57,11 +80,19 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If you derive a class from the <see cref="T:System.Web.UI.Design.WebControls.DataProviderNameConverter" /> class and override the <see cref="M:System.Web.UI.Design.WebControls.DataProviderNameConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method to return an exclusive list of ADO.NET provider names, also override the <see cref="M:System.Web.UI.Design.WebControls.DataProviderNameConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)" /> method to return true when the provider name list is exclusive.</para> + <para>The <paramref name="context" /> parameter is not used by the <see cref="M:System.Web.UI.Design.WebControls.DataProviderNameConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the returned ActiveX® Data Objects (ADO) for the .NET Framework (ADO.NET) provider names are an exclusive list of possible values.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An object implementing the <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides information about a context to a type converter so that the type converter can perform a conversion.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -77,15 +108,22 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <paramref name="context" /> parameter is not used by the <see cref="M:System.Web.UI.Design.WebControls.DataProviderNameConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether this object returns a standard set of ActiveX® Data Objects (ADO) for the .NET Framework (ADO.NET) provider names that can be picked from a list.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An object implementing the <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides information about a context to a type converter so that the type converter can perform a conversion.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/HyperLinkDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/HyperLinkDesigner.xml index a5147d58d78..ef7b3fc64de 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/HyperLinkDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/HyperLinkDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="HyperLinkDesigner" FullName="System.Web.UI.Design.WebControls.HyperLinkDesigner"> <TypeSignature Language="C#" Value="public class HyperLinkDesigner : System.Web.UI.Design.TextControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.WebControls.HyperLink" /> control creates a link for the client browser to navigate to another Web page.</para> + <para>In a visual designer, when you switch from Source to Design view, the markup source code that describes a <see cref="T:System.Web.UI.WebControls.HyperLink" /> control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The <see cref="T:System.Web.UI.Design.WebControls.HyperLinkDesigner" /> class provides design-time support for the <see cref="T:System.Web.UI.WebControls.HyperLink" /> control.</para> + <para>The <see cref="M:System.Web.UI.Design.WebControls.HyperLinkDesigner.GetDesignTimeHtml" /> method returns the markup that is used to render the associated <see cref="T:System.Web.UI.WebControls.HyperLink" /> control at design time. The <see cref="M:System.Web.UI.Design.WebControls.HyperLinkDesigner.OnComponentChanged(System.Object,System.ComponentModel.Design.ComponentChangedEventArgs)" /> method is called when there is a change to the associated control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a visual designer for the <see cref="T:System.Web.UI.WebControls.HyperLink" /> Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +28,14 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.Design.WebControls.HyperLinkDesigner" /> class when it creates the associated <see cref="T:System.Web.UI.WebControls.HyperLink" /> control or a copy of the <see cref="T:System.Web.UI.WebControls.HyperLink" /> control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.HyperLinkDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -35,9 +50,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.HyperLinkDesigner.GetDesignTimeHtml" /> method generates the design-time markup for the associated <see cref="T:System.Web.UI.WebControls.HyperLink" /> control. The method first saves local copies of the <see cref="P:System.Web.UI.WebControls.HyperLink.Text" />, <see cref="P:System.Web.UI.WebControls.HyperLink.NavigateUrl" />, and <see cref="P:System.Web.UI.WebControls.HyperLink.ImageUrl" /> properties, as well as the <see cref="P:System.Web.UI.Control.Controls" /> child collection. It provides default values for these properties if the original values are null or blank. The <see cref="M:System.Web.UI.Design.WebControls.HyperLinkDesigner.GetDesignTimeHtml" /> method then calls the <see cref="M:System.Web.UI.Design.TextControlDesigner.GetDesignTimeHtml" /> base method to generate the markup and restores the properties and child control collection to their original values, if necessary.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the markup that is used to render the associated control at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -45,4 +66,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/LabelDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/LabelDesigner.xml index 8bbc9ba75c9..43612145555 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/LabelDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/LabelDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="LabelDesigner" FullName="System.Web.UI.Design.WebControls.LabelDesigner"> <TypeSignature Language="C#" Value="public class LabelDesigner : System.Web.UI.Design.TextControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.WebControls.Label" /> control allows text to be displayed programmatically on a Web page.</para> + <para>In a visual designer, when you switch from Source to Design view, the markup source code that describes a <see cref="T:System.Web.UI.WebControls.Label" /> control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The <see cref="T:System.Web.UI.Design.WebControls.LabelDesigner" /> class provides design-time support for the <see cref="T:System.Web.UI.WebControls.Label" /> control.</para> + <para>The <see cref="M:System.Web.UI.Design.WebControls.LabelDesigner.OnComponentChanged(System.Object,System.ComponentModel.Design.ComponentChangedEventArgs)" /> method is called when there is a change to the associated <see cref="T:System.Web.UI.WebControls.Label" /> control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a visual designer for the <see cref="T:System.Web.UI.WebControls.Label" /> Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +28,14 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.Design.WebControls.LabelDesigner" /> class when it creates the associated <see cref="T:System.Web.UI.WebControls.Label" /> control or a copy of the <see cref="T:System.Web.UI.WebControls.Label" /> control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.LabelDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -28,4 +43,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/LinkButtonDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/LinkButtonDesigner.xml index c032d3743ee..ca6e20e5fa5 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/LinkButtonDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/LinkButtonDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="LinkButtonDesigner" FullName="System.Web.UI.Design.WebControls.LinkButtonDesigner"> <TypeSignature Language="C#" Value="public class LinkButtonDesigner : System.Web.UI.Design.TextControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.WebControls.LinkButton" /> control implements the functionality of a <see cref="T:System.Web.UI.WebControls.HyperLink" /> control with the visual appearance of a button.</para> + <para>In a visual designer, when you switch from Source to Design view, the markup source code that describes a <see cref="T:System.Web.UI.WebControls.LinkButton" /> control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The <see cref="T:System.Web.UI.Design.WebControls.LinkButtonDesigner" /> class provides design-time support for the <see cref="T:System.Web.UI.WebControls.LinkButton" /> control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a visual designer for the <see cref="T:System.Web.UI.WebControls.LinkButton" /> Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,14 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.Design.WebControls.LinkButtonDesigner" /> class when it creates the associated <see cref="T:System.Web.UI.WebControls.LinkButton" /> control or a copy of the <see cref="T:System.Web.UI.WebControls.LinkButton" /> control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.LinkButtonDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -28,4 +42,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/ListControlDataBindingHandler.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/ListControlDataBindingHandler.xml index 4c43077a9be..63a6caca367 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/ListControlDataBindingHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/ListControlDataBindingHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ListControlDataBindingHandler" FullName="System.Web.UI.Design.WebControls.ListControlDataBindingHandler"> <TypeSignature Language="C#" Value="public class ListControlDataBindingHandler : System.Web.UI.Design.DataBindingHandler" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.WebControls.ListControlDataBindingHandler" /> class performs design-time data binding of a <see cref="T:System.Web.UI.WebControls.ListControl" /> control. The <see cref="T:System.Web.UI.Design.WebControls.ListControlDataBindingHandler" /> class is referenced by the <see cref="T:System.Web.UI.WebControls.ListControl" /> using the <see cref="T:System.Web.UI.DataBindingHandlerAttribute" /> class.</para> + <para>The <see cref="M:System.Web.UI.Design.WebControls.ListControlDataBindingHandler.DataBindControl(System.ComponentModel.Design.IDesignerHost,System.Web.UI.Control)" /> method performs the design-time data binding.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Performs data binding of a <see cref="T:System.Web.UI.WebControls.ListControl" /> Web server control within a visual designer.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,14 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.Design.WebControls.ListControlDataBindingHandler" /> class when the class is referenced by a <see cref="T:System.Web.UI.DataBindingHandlerAttribute" /> attribute. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.ListControlDataBindingHandler" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,9 +53,16 @@ </Parameters> <Docs> <param name="designer_host">To be added.</param> - <param name="control">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="T:System.Web.UI.WebControls.ListControl" /> control that is specified by <paramref name="control" /> has a data source specified within its <see cref="P:System.Web.UI.IDataBindingsAccessor.DataBindings" /> property, the <see cref="M:System.Web.UI.Design.WebControls.ListControlDataBindingHandler.DataBindControl(System.ComponentModel.Design.IDesignerHost,System.Web.UI.Control)" /> method clears the <see cref="P:System.Web.UI.WebControls.ListControl.Items" /> collection of the <see cref="T:System.Web.UI.WebControls.ListControl" />, and then adds a string message indicating that the <see cref="T:System.Web.UI.WebControls.ListControl" /> is data bound to the <see cref="P:System.Web.UI.WebControls.ListControl.Items" /> collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Performs data binding on the specified control.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> to bind. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -49,4 +70,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/PanelDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/PanelDesigner.xml index 2e62f617caa..e8fac829219 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/PanelDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/PanelDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="PanelDesigner" FullName="System.Web.UI.Design.WebControls.PanelDesigner"> <TypeSignature Language="C#" Value="public class PanelDesigner : System.Web.UI.Design.ReadWriteControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,17 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.WebControls.Panel" /> control is used as a container for other controls, especially when controls are generated programmatically.</para> + <para>The <see cref="T:System.Web.UI.Design.WebControls.PanelDesigner" /> class provides design-time support for <see cref="T:System.Web.UI.WebControls.Panel" /> controls in a visual designer. However, for all new implementations of the Panel control, use the <see cref="T:System.Web.UI.Design.WebControls.PanelContainerDesigner" /> instead of the <see cref="T:System.Web.UI.Design.WebControls.PanelDesigner" />.</para> + <para>In a visual designer, when you switch from Source to Design view, the markup source code that describes the associated <see cref="T:System.Web.UI.WebControls.Panel" /> control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to markup source code and edited into the markup for the Web page. </para> + <para>The <see cref="M:System.Web.UI.Design.WebControls.PanelDesigner.MapPropertyToStyle(System.String,System.Object)" /> method maps a specified property and value to a specified markup style. The <see cref="M:System.Web.UI.Design.WebControls.PanelDesigner.OnBehaviorAttached" /> method provides notification when a behavior is attached to the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a visual designer for the <see cref="T:System.Web.UI.WebControls.Panel" /> control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +29,14 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.Design.WebControls.PanelDesigner" /> class when it creates the associated <see cref="T:System.Web.UI.WebControls.Panel" /> control or a copy of that control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.PanelDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -40,8 +56,14 @@ <Docs> <param name="name">To be added.</param> <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.PanelDesigner.MapPropertyToStyle(System.String,System.Object)" /> method provides special handling for the <see cref="P:System.Web.UI.WebControls.Panel.BackImageUrl" /> and <see cref="P:System.Web.UI.WebControls.Panel.HorizontalAlign" /> properties, but calls the <see cref="M:System.Web.UI.Design.ReadWriteControlDesigner.MapPropertyToStyle(System.String,System.Object)" /> base method for all other values of the <paramref name="propName" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Maps a specified property and value to a specified markup style.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -56,8 +78,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.PanelDesigner.OnBehaviorAttached" /> method calls the <see cref="M:System.Web.UI.Design.ReadWriteControlDesigner.OnBehaviorAttached" /> base method. Then the <see cref="M:System.Web.UI.Design.WebControls.PanelDesigner.OnBehaviorAttached" /> maps the <see cref="P:System.Web.UI.WebControls.Panel.BackImageUrl" /> and <see cref="P:System.Web.UI.WebControls.Panel.HorizontalAlign" /> properties to the appropriate style by using the <see cref="M:System.Web.UI.Design.WebControls.PanelDesigner.MapPropertyToStyle(System.String,System.Object)" /> method, if these properties are defined.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides notification when a behavior is attached to the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -65,4 +93,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RegexEditorDialog.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RegexEditorDialog.xml index 561f863cbbf..502dc9ad4c5 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RegexEditorDialog.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RegexEditorDialog.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="RegexEditorDialog" FullName="System.Web.UI.Design.WebControls.RegexEditorDialog"> <TypeSignature Language="C#" Value="public class RegexEditorDialog : System.Windows.Forms.Form" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a dialog box for editing regular expressions used by the <see cref="T:System.Web.UI.WebControls.RegularExpressionValidator" />.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -100,9 +104,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public <see cref="M:System.ComponentModel.Component.Dispose" /> method and the <see cref="M:System.Object.Finalize" /> method. <see cref="M:System.ComponentModel.Component.Dispose" /> invokes the protected <see cref="M:System.Web.UI.Design.WebControls.RegexEditorDialog.Dispose(System.Boolean)" /> method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.Web.UI.Design.WebControls.RegexEditorDialog" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.Web.UI.Design.WebControls.RegexEditorDialog" /> and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />A value indicating to all resources held by any managed objects that this <see cref="T:System.Web.UI.Design.WebControls.RegexEditorDialog" /> references.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -141,10 +153,15 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="sender">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the Activated event of dialog box.</para> + </summary> + <param name="sender"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event. </param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -158,9 +175,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the name of the regular expression to edit.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -189,4 +209,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RegexTypeEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RegexTypeEditor.xml index 7415d91a986..2fbc22a475c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RegexTypeEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RegexTypeEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="RegexTypeEditor" FullName="System.Web.UI.Design.WebControls.RegexTypeEditor"> <TypeSignature Language="C#" Value="public class RegexTypeEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for editing regular expressions.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of the <see cref="T:System.Web.UI.Design.WebControls.RegexTypeEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,12 +46,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the given regular expression object using the given service provider and context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can provide additional context information.</param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The regular expression object whose value is to be edited.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,10 +74,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editor style used by the <see cref="M:System.Web.UI.Design.WebControls.RegexTypeEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -72,4 +89,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RepeaterDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RepeaterDesigner.xml index 44369c09054..5b7e5899c72 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RepeaterDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/RepeaterDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="RepeaterDesigner" FullName="System.Web.UI.Design.WebControls.RepeaterDesigner"> <TypeSignature Language="C#" Value="public class RepeaterDesigner : System.Web.UI.Design.ControlDesigner, System.Web.UI.Design.IDataSourceProvider" /> <AssemblyInfo> @@ -14,8 +15,11 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends design-time behavior for the <see cref="T:System.Web.UI.WebControls.Repeater" /> control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,8 +27,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.RepeaterDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,9 +45,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the name of a specific table or view in the data source object to bind the <see cref="T:System.Web.UI.WebControls.Repeater" /> control to.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -54,9 +64,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A data-binding expression that identifies the source of data for the associated <see cref="T:System.Web.UI.WebControls.Repeater" /> control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -73,9 +86,16 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When the disposing parameter is true, the Dispose method releases all the resources held by the managed objects that this <see cref="T:System.Web.UI.Design.WebControls.RepeaterDesigner" /> object references.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.Web.UI.Design.WebControls.RepeaterDesigner" /> object and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both the managed and unmanaged resources; false to release only the unmanaged resources.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -93,9 +113,12 @@ </Parameters> <Docs> <param name="minimum_rows">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns design-time sample data based on the <see cref="M:System.Web.UI.Design.WebControls.RepeaterDesigner.GetResolvedSelectedDataSource" /> method and using the specified number of rows.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -115,9 +138,12 @@ <Docs> <param name="selected_data_source">To be added.</param> <param name="minimum_rows">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns design-time sample data based on the provided data and using the specified number of rows.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -132,9 +158,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup to be used for the design-time representation of the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -149,9 +178,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup to represent a Web server control at design time that will have no visual representation at run time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -168,10 +200,14 @@ <Parameter Name="e" Type="System.Exception" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup that provides information about the specified exception.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The exception that occurred.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -186,9 +222,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.RepeaterDesigner.GetResolvedSelectedDataSource" /> method uses the <see cref="M:System.Web.UI.Design.WebControls.RepeaterDesigner.GetSelectedDataSource" /> method to construct a data source from the object that is specified by the <see cref="P:System.Web.UI.Design.WebControls.RepeaterDesigner.DataSource" /> and <see cref="P:System.Web.UI.Design.WebControls.RepeaterDesigner.DataMember" /> properties.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the selected data member from the selected data source.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -203,9 +245,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.RepeaterDesigner.GetSelectedDataSource" /> method uses the <see cref="M:System.Web.UI.Design.DesignTimeData.GetSelectedDataSource(System.ComponentModel.IComponent,System.String)" /> method to construct a data source from the object that is specified by the <see cref="P:System.Web.UI.Design.WebControls.RepeaterDesigner.DataSource" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the selected data source component from the container of the associated <see cref="T:System.Web.UI.WebControls.Repeater" /> control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -222,9 +270,13 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer with the provided <see cref="T:System.Web.UI.WebControls.Repeater" /> control.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The associated <see cref="T:System.Web.UI.WebControls.Repeater" /> control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -244,8 +296,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the associated control changes.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -264,8 +319,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Handles changes made to the data source </para> + </summary> </Docs> </Member> <Member MemberName="PreFilterProperties"> @@ -278,9 +336,13 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Filters the properties to replace the runtime data source property descriptor with the designer's property descriptor.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The properties for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -294,9 +356,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the associated control has any templates defined.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -304,4 +369,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableCellsCollectionEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableCellsCollectionEditor.xml index 96c92ed472c..4797dbb88c2 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableCellsCollectionEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableCellsCollectionEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TableCellsCollectionEditor" FullName="System.Web.UI.Design.WebControls.TableCellsCollectionEditor"> <TypeSignature Language="C#" Value="public class TableCellsCollectionEditor : System.ComponentModel.Design.CollectionEditor" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for editing the collection of cells in a table row.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,9 +25,13 @@ <Parameter Name="type" Type="System.Type" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.TableCellsCollectionEditor" /> class.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the collection to edit. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,9 +46,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether multiple table cells can be selected at the same time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -58,9 +69,12 @@ </Parameters> <Docs> <param name="item_type">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of the editor for use with the specified type.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -68,4 +82,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableDesigner.xml index 0619afbabae..b2233633c7b 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TableDesigner" FullName="System.Web.UI.Design.WebControls.TableDesigner"> <TypeSignature Language="C#" Value="public class TableDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends design-time behavior for the <see cref="T:System.Web.UI.WebControls.Table" /> Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.TableDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -35,9 +42,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebControls.TableDesigner.GetDesignTimeHtml" /> method ensures that the table has at least one row and cell and that the cells contain some text for display at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the HTML that is used to represent the control at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -52,9 +65,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member overrides <see cref="M:System.Web.UI.Design.ControlDesigner.GetPersistInnerHtml" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -62,4 +78,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableRowsCollectionEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableRowsCollectionEditor.xml index b238de2f044..04d5d68f0bb 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableRowsCollectionEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/TableRowsCollectionEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TableRowsCollectionEditor" FullName="System.Web.UI.Design.WebControls.TableRowsCollectionEditor"> <TypeSignature Language="C#" Value="public class TableRowsCollectionEditor : System.ComponentModel.Design.CollectionEditor" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for editing rows of a table.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,9 +25,13 @@ <Parameter Name="type" Type="System.Type" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.TableRowsCollectionEditor" /> class.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the collection to edit. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,9 +46,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether multiple instances may be selected.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -58,9 +69,12 @@ </Parameters> <Docs> <param name="item_type">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of the specified type.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -68,4 +82,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/XmlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/XmlDesigner.xml index cd2801bbf8d..9db23765107 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/XmlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design.WebControls/XmlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="XmlDesigner" FullName="System.Web.UI.Design.WebControls.XmlDesigner"> <TypeSignature Language="C#" Value="public class XmlDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends design-time behavior for the <see cref="T:System.Web.UI.WebControls.Xml" /> Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.XmlDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,9 +44,21 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call <see cref="M:System.Web.UI.Design.WebControls.XmlDesigner.Dispose(System.Boolean)" /> when you are finished using the <see cref="T:System.Web.UI.Design.WebControls.XmlDesigner" /> class. The <see cref="M:System.Web.UI.Design.WebControls.XmlDesigner.Dispose(System.Boolean)" /> method leaves the <see cref="T:System.Web.UI.Design.WebControls.XmlDesigner" /> in an unusable state. After calling <see cref="M:System.Web.UI.Design.WebControls.XmlDesigner.Dispose(System.Boolean)" />, you must release all references to the <see cref="T:System.Web.UI.Design.WebControls.XmlDesigner" /> so the garbage collector can reclaim the memory that the <see cref="T:System.Web.UI.Design.WebControls.XmlDesigner" /> 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.Web.UI.Design.WebControls.XmlDesigner.Dispose(System.Boolean)" /> before you release your last reference to the <see cref="T:System.Web.UI.Design.WebControls.XmlDesigner" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.Web.UI.Design.WebControls.XmlDesigner" /> object's Finalize method.</para> + </block> + <para>The <see cref="M:System.Web.UI.Design.WebControls.XmlDesigner.Dispose(System.Boolean)" /> method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. The Dispose() invokes the protected Dispose(Boolean) method with <paramref name="disposing" /> set to true. The <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When <paramref name="disposing" /> is true, the <see cref="M:System.Web.UI.Design.WebControls.XmlDesigner.Dispose(System.Boolean)" /> method releases all resources that are held by any managed objects that this <see cref="T:System.Web.UI.Design.WebControls.XmlDesigner" /> references. The <see cref="M:System.Web.UI.Design.WebControls.XmlDesigner.Dispose(System.Boolean)" /> method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources that are used by the <see cref="T:System.Web.UI.Design.WebControls.XmlDesigner" /> control and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -54,9 +73,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup that is used to represent the control at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -71,9 +93,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the HTML that is used to fill an empty control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -90,9 +115,13 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer with the control that this instance of the designer is associated with.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The associated control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -100,4 +129,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/AppSettingsExpressionEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/AppSettingsExpressionEditor.xml index e0ce95ddc40..3ffce919f0a 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/AppSettingsExpressionEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/AppSettingsExpressionEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="AppSettingsExpressionEditor" FullName="System.Web.UI.Design.AppSettingsExpressionEditor"> <TypeSignature Language="C#" Value="public class AppSettingsExpressionEditor : System.Web.UI.Design.ExpressionEditor" /> <AssemblyInfo> @@ -9,9 +10,19 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.AppSettingsExpressionEditor" /> class is derived from the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class and provides an implementation for evaluating and associating an application setting reference with a control property at design time. For example, you can bind the value of a control property to the application setting expression AppSettings:mySettingKeyName, which indicates that the control property value is set using the mySettingKeyName value in the appSettings section of the Web configuration file.</para> + <para>A visual designer host, such as vsprvslong, uses the <see cref="T:System.Web.UI.Design.AppSettingsExpressionEditor" /> class to select an application setting from the appSettings configuration section, and then evaluates the selected expression for design-time rendering.</para> + <para>When you browse to the <see cref="P:System.Web.UI.Design.HtmlControlDesigner.Expressions" /> property for a control in the design-time properties grid, the visual designer displays a dialog box to set expressions that provide the run-time value for a control property. You can select the expression type based on a list of expression prefixes. When you select the <ui>AppSettings</ui> expression prefix from the list, the visual designer host uses the associated <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> object to provide design-time editing functionality of appSettings expressions and uses <see cref="T:System.Web.UI.Design.AppSettingsExpressionEditor" /> methods to evaluate and convert the expression string based on the syntax for an application setting expression. The visual designer host uses the evaluated expression result to assign control property values that are rendered on the design surface.</para> + <para>The <see cref="P:System.Web.UI.Design.ExpressionEditor.ExpressionPrefix" /> property for an <see cref="T:System.Web.UI.Design.AppSettingsExpressionEditor" /> object returns the string AppSettings. The <see cref="T:System.Web.Compilation.AppSettingsExpressionBuilder" /> class is associated with the expression prefix AppSettings and the <see cref="T:System.Web.UI.Design.AppSettingsExpressionEditor" /> implementation.</para> + <para>The <see cref="M:System.Web.UI.Design.AppSettingsExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method evaluates an input application setting expression string. The <see cref="M:System.Web.UI.Design.ExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns the <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> implementation that is used to enter and edit application setting expressions.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides properties and methods for evaluating and editing an application setting expression in a configuration file at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +30,15 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An instance of the <see cref="T:System.Web.UI.Design.AppSettingsExpressionEditor" /> class is configured by the base class together with the <see cref="P:System.Web.UI.Design.ExpressionEditor.ExpressionPrefix" /> property set to AppSettings.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.AppSettingsExpressionEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -40,14 +57,26 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="parseTimeData">To be added.</param> - <param name="propertyType">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.AppSettingsExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method looks up the application setting that is specified by <paramref name="expression" />, and then returns the value of the application setting.</para> + <para>The visual designer uses the <see cref="M:System.Web.UI.Design.AppSettingsExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method to evaluate an application setting expression and provide the design-time value for an associated control property. The visual designer calls the <see cref="M:System.Web.UI.Design.AppSettingsExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method with the expression string, and uses the evaluated expression result to assign control property values that are rendered on the design surface.</para> + <para>At run time, the page parser uses the <see cref="M:System.Web.Compilation.AppSettingsExpressionBuilder.EvaluateExpression(System.Object,System.Web.UI.BoundPropertyEntry,System.Object,System.Web.Compilation.ExpressionBuilderContext)" /> and <see cref="M:System.Web.Compilation.AppSettingsExpressionBuilder.GetCodeExpression(System.Web.UI.BoundPropertyEntry,System.Object,System.Web.Compilation.ExpressionBuilderContext)" /> methods of the corresponding <see cref="T:System.Web.Compilation.AppSettingsExpressionBuilder" /> implementation to evaluate an expression and provide the run-time value for an associated control property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Evaluates an application setting expression string and provides the design-time value for a control property.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />An application setting expression string to evaluate. <paramref name="expression" /> does not include the AppSettings expression prefix.</param> + <param name="parseTimeData"> + <attribution license="cc4" from="Microsoft" modified="false" />An object containing additional parsing information for evaluating <paramref name="expression" />.</param> + <param name="propertyType"> + <attribution license="cc4" from="Microsoft" modified="false" />The control property type.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -64,16 +93,24 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.AppSettingsExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns a simple editor sheet implementation, which uses a single input string to form the expression.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an expression editor sheet for an application setting expression.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />The expression string set for a control property, used to initialize the expression editor sheet. <paramref name="expression" /> does not include the AppSettings expression prefix.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/CalendarDataBindingHandler.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/CalendarDataBindingHandler.xml index a926312a437..0cae624e49e 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/CalendarDataBindingHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/CalendarDataBindingHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CalendarDataBindingHandler" FullName="System.Web.UI.Design.CalendarDataBindingHandler"> <TypeSignature Language="C#" Value="public class CalendarDataBindingHandler : System.Web.UI.Design.DataBindingHandler" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a data-binding handler for a calendar.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes an instance of the <see cref="T:System.Web.UI.Design.CalendarDataBindingHandler" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,10 +45,15 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <param name="control">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the calendar's date to the current day if the <see cref="P:System.Web.UI.WebControls.Calendar.SelectedDate" /> property is data-bound.</para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.IDesignerHost" /> for the document that contains the control. </param> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> to which data binding will be added. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -49,4 +61,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ClientScriptItem.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ClientScriptItem.xml index 169f5ae017f..40551aef697 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ClientScriptItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ClientScriptItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ClientScriptItem" FullName="System.Web.UI.Design.ClientScriptItem"> <TypeSignature Language="C#" Value="public sealed class ClientScriptItem" /> <AssemblyInfo> @@ -9,8 +10,21 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ClientScriptItem" /> class represents a script element that is contained in a Web document at design time. A custom control designer implementation can use a <see cref="T:System.Web.UI.Design.ClientScriptItem" /> object to add client script elements to a Web Form or user control.</para> + <para>At design time, use the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> class to set or examine client script elements that are contained in a document, such as a Web form, a Web server control, a content page, or a master page, on the design surface. Retrieve the collection of client script elements that are contained within the Web document by using the <see cref="M:System.Web.UI.Design.WebFormsRootDesigner.GetClientScriptsInDocument" /> method. Add a client script element to the Web document by using the <see cref="M:System.Web.UI.Design.WebFormsRootDesigner.AddClientScriptToDocument(System.Web.UI.Design.ClientScriptItem)" /> method.</para> + <para>Typically, a script element either contains script statements or specifies an external location for script statements. The script element can optionally define the language of the script statements. Use the <see cref="M:System.Web.UI.Design.ClientScriptItem.#ctor(System.String,System.String,System.String,System.String,System.String)" /> constructor to initialize the properties for a new script object. Use the <see cref="T:System.Web.UI.Design.ClientScriptItem" /> properties to examine the script object attributes and contents. The <see cref="P:System.Web.UI.Design.ClientScriptItem.Language" /> property represents the language attribute of the script element. The <see cref="P:System.Web.UI.Design.ClientScriptItem.Source" /> property represents the src attribute. The <see cref="P:System.Web.UI.Design.ClientScriptItem.Text" /> property represents the script statements to be executed on the client that are contained in the script element. </para> + <para>Use the <see cref="T:System.Web.UI.Design.ClientScriptItem" /> class to manage scripts that are to be executed at design-time.</para> + <para>To manage client script elements at run time, use the <see cref="T:System.Web.UI.ClientScriptManager" /> class. For more information about using client scripts at run time, see <format type="text/html"><a href="13edb6b9-2dea-43c6-b8c1-a47207de19aa">Client Script in ASP.NET Web Pages</a></format>.</para> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ClientScriptItem" /> class represents script elements at design time that are ultimately parsed and run in the client browser. Because the script elements that are generated for the <see cref="T:System.Web.UI.Design.ClientScriptItem" /> objects are not run on the server, the elements do not contain the runat="server" attribute.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a client script element in a Web Form or user control at design time. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,13 +41,44 @@ <Parameter Name="id" Type="System.String" /> </Parameters> <Docs> - <param name="text">To be added.</param> - <param name="source">To be added.</param> - <param name="language">To be added.</param> - <param name="type">To be added.</param> - <param name="id">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initialize the statements for the <see cref="T:System.Web.UI.Design.ClientScriptItem" /> object by using either the <paramref name="text" /> or <paramref name="source" /> parameter (not both). Use <paramref name="text" /> to initialize the script using an input string that contains the statements. Alternately, use <paramref name="source" /> to initialize a script using a path that contains the script statements.</para> + <para>You can specify any of the input parameters as null or an empty string (""); the corresponding property is set using the input value, and the script element is generated without that property. Using null or an empty string ("") generates the following results: </para> + <list type="bullet"> + <item> + <para>For <paramref name="text" />, the corresponding script element does not contain script statements. </para> + </item> + <item> + <para>For <paramref name="source" />, the src attribute is not set in the script element. </para> + </item> + <item> + <para>For <paramref name="language" />, the language attribute is not set in the script element. </para> + <para>When a client script block does not specify the script language, the client browser determines the language.</para> + </item> + <item> + <para>For <paramref name="type" />, the type attribute is not set in the script element.</para> + <para>When a client script block does not specify the script type, the client browser determines the type.</para> + </item> + <item> + <para>For <paramref name="id" />, the design host (for example, vsprvslong) will throw an <see cref="T:System.ArgumentNullException" />.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ClientScriptItem" /> class using the provided parameters.</para> + </summary> + <param name="text"> + <attribution license="cc4" from="Microsoft" modified="false" />The contents for the script element; a string of script statements to run on the client.</param> + <param name="source"> + <attribution license="cc4" from="Microsoft" modified="false" />The src attribute value for the script element, specifying an external source location for the client script contents.</param> + <param name="language"> + <attribution license="cc4" from="Microsoft" modified="false" />The language attribute value for the script element, specifying the language of the script statements.</param> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The type attribute value for the script element, indicating the MIME type for the associated scripting engine.</param> + <param name="id"> + <attribution license="cc4" from="Microsoft" modified="false" />The ID for the script element. This argument is required by the design host (for example, vsprvslong).</param> </Docs> </Member> <Member MemberName="Id"> @@ -46,9 +91,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the ID attribute value for the client script element.</para> + </summary> </Docs> </Member> <Member MemberName="Language"> @@ -61,9 +109,16 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ClientScriptItem.Language" /> property represents the language in which the script statements are written. If the <see cref="P:System.Web.UI.Design.ClientScriptItem.Language" /> property is null or an empty string (""), the language attribute is not set in the script element. When a client script block does not specify the script language, the client browser determines the language.</para> + <para>The <see cref="P:System.Web.UI.Design.ClientScriptItem.Language" /> property is initialized by the <see cref="M:System.Web.UI.Design.ClientScriptItem.#ctor(System.String,System.String,System.String,System.String,System.String)" /> constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the language attribute value for the client script element.</para> + </summary> </Docs> </Member> <Member MemberName="Source"> @@ -76,9 +131,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ClientScriptItem.Source" /> property specifies an external source location for the client script contents. Typically, the script statements for a script element are specified using either the <see cref="P:System.Web.UI.Design.ClientScriptItem.Text" /> or <see cref="P:System.Web.UI.Design.ClientScriptItem.Source" /> property. </para> + <para>If the <see cref="P:System.Web.UI.Design.ClientScriptItem.Source" /> property is null or an empty string (""), the src attribute is not set in the script element.</para> + <para>The <see cref="P:System.Web.UI.Design.ClientScriptItem.Source" /> property is initialized by the <see cref="M:System.Web.UI.Design.ClientScriptItem.#ctor(System.String,System.String,System.String,System.String,System.String)" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the src attribute value for the client script element.</para> + </summary> </Docs> </Member> <Member MemberName="Text"> @@ -91,9 +154,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ClientScriptItem.Text" /> property represents the statements that are contained in the script element. Typically, the script statements for a script element are specified using either the <see cref="P:System.Web.UI.Design.ClientScriptItem.Text" /> or <see cref="P:System.Web.UI.Design.ClientScriptItem.Source" /> property. </para> + <para>If the <see cref="P:System.Web.UI.Design.ClientScriptItem.Text" /> property is null or an empty string (""), the script element does not contain any script statements.</para> + <para>The <see cref="P:System.Web.UI.Design.ClientScriptItem.Source" /> property is initialized by the <see cref="M:System.Web.UI.Design.ClientScriptItem.#ctor(System.String,System.String,System.String,System.String,System.String)" /> constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the script statements contained in the client script element.</para> + </summary> </Docs> </Member> <Member MemberName="Type"> @@ -106,10 +177,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type attribute value for the client script element.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ClientScriptItemCollection.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ClientScriptItemCollection.xml index d8316887967..d3bcb1f95c6 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ClientScriptItemCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ClientScriptItemCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ClientScriptItemCollection" FullName="System.Web.UI.Design.ClientScriptItemCollection"> <TypeSignature Language="C#" Value="public sealed class ClientScriptItemCollection : System.Collections.ReadOnlyCollectionBase" /> <AssemblyInfo> @@ -9,8 +10,19 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Each <see cref="T:System.Web.UI.Design.ClientScriptItem" /> object in the <see cref="T:System.Web.UI.Design.ClientScriptItemCollection" /> class represents a script block that is contained in a document (a Web Form, Web server control, a content page, or a master page) at design time.</para> + <para>Use the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> class to set or examine client script elements that are contained in a Web Forms document on the design surface. Retrieve the collection of client script elements that are contained within the Web document by using the <see cref="M:System.Web.UI.Design.WebFormsRootDesigner.GetClientScriptsInDocument" /> method. Add a client script element to the Web document by using the <see cref="M:System.Web.UI.Design.WebFormsRootDesigner.AddClientScriptToDocument(System.Web.UI.Design.ClientScriptItem)" /> method.</para> + <para>To add client script elements at run time, use the <see cref="T:System.Web.UI.ClientScriptManager" /> class.</para> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ClientScriptItemCollection" /> class represents script elements at design time that execute on the client. Because the script elements that are generated for <see cref="T:System.Web.UI.Design.ClientScriptItemCollection" /> objects are not run on the server, the elements do not contain the runat="server" attribute.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a read-only collection of client script blocks that are contained within a Web Form or user control at design time. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,10 +35,18 @@ <Parameter Name="clientScriptItems" Type="System.Web.UI.Design.ClientScriptItem[]" /> </Parameters> <Docs> - <param name="clientScriptItems">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If <paramref name="clientScriptItems" /> is null (Nothing in Visual Basic) or does not contain any elements, the constructor initializes an empty <see cref="T:System.Web.UI.Design.ClientScriptItemCollection" /> object. Otherwise, the items in the <paramref name="clientScriptItems" /> array are used to set the items for the <see cref="T:System.Web.UI.Design.ClientScriptItemCollection" />.</para> + <para>The <see cref="M:System.Web.UI.Design.ClientScriptItemCollection.#ctor(System.Web.UI.Design.ClientScriptItem[])" /> constructor is typically used in classes that are derived from the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> class. Visual designers implement the <see cref="M:System.Web.UI.Design.WebFormsRootDesigner.GetClientScriptsInDocument" /> method to return a <see cref="T:System.Web.UI.Design.ClientScriptItemCollection" /> object for the client script elements in a Web document at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ClientScriptItemCollection" /> class. </para> + </summary> + <param name="clientScriptItems"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of <see cref="T:System.Web.UI.Design.ClientScriptItem" /> elements used to initialize the collection.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ColorBuilder.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ColorBuilder.xml index 601cbfbc33a..b97c3e19414 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ColorBuilder.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ColorBuilder.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ColorBuilder" FullName="System.Web.UI.Design.ColorBuilder"> <TypeSignature Language="C#" Value="public sealed class ColorBuilder" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ColorBuilder.BuildColor(System.ComponentModel.IComponent,System.Windows.Forms.Control,System.String)" /> method starts a user interface for selecting a color value.</para> + <para>The <see cref="T:System.Web.UI.Design.ColorBuilder" /> class is not intended for use outside of the design time environment. <see cref="T:System.Web.UI.Design.ColorBuilder" /> requires the <see cref="T:System.Web.UI.Design.IWebFormsBuilderUIService" />, which is typically available within a Web Forms project at design time. If you want to build HTML color strings, you may want to implement a method that converts the RGB values of a <see cref="T:System.Drawing.Color" /> object to an HTML-compatible RRGGBB format string. If you intend to use a control to select a color or configure a color, you can build a user interface for this, or you may want to use a <see cref="T:System.Windows.Forms.PropertyGrid" /> control which allows you to edit <see cref="T:System.Drawing.Color" /> properties with the default <see cref="T:System.Drawing.Design.ColorEditor" /> providing a color selection interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an HTML color string builder at design time that allows a user to select a color.</para> + </summary> </Docs> <Members> <Member MemberName="BuildColor"> @@ -26,12 +34,21 @@ <Parameter Name="initialColor" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="owner">To be added.</param> - <param name="initialColor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The returned string, if other than null, indicates a color in a valid HTML color format. Valid formats include named colors and color codes in RGB format (#RRGGBB).</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Starts a color editor to build an HTML color property value.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> whose site is to be used to access design-time services. </param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> used to parent the picker window. </param> + <param name="initialColor"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial color to be shown in the picker window, in a valid HTML color format. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,4 +56,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ConnectionStringEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ConnectionStringEditor.xml index dad00c516b2..5ddfd0ab619 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ConnectionStringEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ConnectionStringEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ConnectionStringEditor" FullName="System.Web.UI.Design.ConnectionStringEditor"> <TypeSignature Language="C#" Value="public class ConnectionStringEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class is a <see cref="T:System.Drawing.Design.UITypeEditor" /> object that can be used at design time to select and edit a connection string expression and to assign the expression to a control property. For example, the <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> control uses the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class at design time to set the value of the <see cref="P:System.Web.UI.WebControls.SqlDataSource.ConnectionString" /> property.</para> + <para>Use the <see cref="T:System.ComponentModel.EditorAttribute" /> attribute to associate the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> with a property. When the associated property is edited on the design surface, the designer host calls the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method. The <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method displays a user interface for building the connection string expression and returns the connection string that is selected by the user. The <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method indicates the display style of the user interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base class for a user interface to select and edit a connection string property at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +29,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="EditValue"> @@ -40,12 +51,23 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method starts the user interface for editing the <paramref name="value" /> object. The designer host calls the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method when you edit the value of a property that the connection string editor is associated with. The input service provider is used to obtain any editing services that are required within the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method.</para> + <para>If an <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> service implementation is supported in the specified context, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method initializes a <see cref="T:System.Web.UI.WebControls.ListBox" /> control, which prompts you to select an existing connection expression or build a new connection expression. If an <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> service implementation is not supported in the specified context, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method displays a simple instance of the <see cref="T:System.Windows.Forms.Form" /> class, which prompts you to enter the connection expression string. </para> + <para>If you cancel without selecting a connection expression string, the returned object is the same as the <paramref name="value" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the specified object by using the specified service provider and context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> to use to gain additional context information.</param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which to obtain editing services.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the object being edited.</param> </Docs> </Member> <Member MemberName="GetEditStyle"> @@ -61,10 +83,18 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>By default, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class returns the <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.Modal" /> value. If an <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> service implementation is supported in the specified context, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method returns the <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.DropDown" /> value.</para> + <para>If the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method is not supported in the specified context, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method returns the <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" /> value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the editing style that is associated with the connection string editor for the specified context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> to use to gain additional context information.</param> </Docs> </Member> <Member MemberName="GetProviderName"> @@ -80,10 +110,17 @@ <Parameter Name="instance" Type="System.Object" /> </Parameters> <Docs> - <param name="instance">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ConnectionStringEditor.GetProviderName(System.Object)" /> method gets the provider name for the current instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class. For example, in the <see cref="T:System.Web.UI.Design.WebControls.SqlDataSourceConnectionStringEditor" /> class, which is derived from <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class, the <see cref="M:System.Web.UI.Design.ConnectionStringEditor.GetProviderName(System.Object)" /> method returns the provider name.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the provider name for the provided instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class.</para> + </summary> + <param name="instance"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> or an instance of a derived class.</param> </Docs> </Member> <Member MemberName="SetProviderName"> @@ -100,11 +137,19 @@ <Parameter Name="connection" Type="System.ComponentModel.Design.Data.DesignerDataConnection" /> </Parameters> <Docs> - <param name="instance">To be added.</param> - <param name="connection">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ConnectionStringEditor.SetProviderName(System.Object,System.ComponentModel.Design.Data.DesignerDataConnection)" /> method sets the provider name on the <paramref name="instance" /> parameter. For example, in the SqlDataSourceConnectionStringEditor, which derives from the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class, this either sets the provider name or adds an <see cref="T:System.Web.UI.ExpressionBinding" /> object, if the connection is a configured connection. In this implementation, the <see cref="M:System.Web.UI.Design.ConnectionStringEditor.SetProviderName(System.Object,System.ComponentModel.Design.Data.DesignerDataConnection)" /> method does nothing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Puts the provider name on the specified instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class.</para> + </summary> + <param name="instance"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> or an instance of a derived class.</param> + <param name="connection"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ConnectionStringsExpressionEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ConnectionStringsExpressionEditor.xml index 2f66fab9c50..b81db4d7c8c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ConnectionStringsExpressionEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ConnectionStringsExpressionEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ConnectionStringsExpressionEditor" FullName="System.Web.UI.Design.ConnectionStringsExpressionEditor"> <TypeSignature Language="C#" Value="public class ConnectionStringsExpressionEditor : System.Web.UI.Design.ExpressionEditor" /> <AssemblyInfo> @@ -9,9 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A visual designer host, such as vsprvslong, uses the <see cref="T:System.Web.UI.Design.ConnectionStringsExpressionEditor" /> class to select a connection string from the connectionStrings configuration section.</para> + <para>The <see cref="T:System.Web.UI.Design.ConnectionStringsExpressionEditor" /> class is derived from the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class, and although it is public for technical reasons, there is no advantage in deriving from it.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides properties and methods for selecting a data connection expression that is associated with a control property at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +27,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ConnectionStringsExpressionEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -40,14 +51,26 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="parseTimeData">To be added.</param> - <param name="propertyType">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ConnectionStringsExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method looks up the connection name and type specified by <paramref name="expression" />, and then returns the connection.</para> + <para>The visual designer uses the <see cref="M:System.Web.UI.Design.ConnectionStringsExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method to evaluate a connection string expression and provide the design-time value for an associated control property. The visual designer uses the <see cref="M:System.Web.Compilation.ConnectionStringsExpressionBuilder.ParseExpression(System.String,System.Type,System.Web.Compilation.ExpressionBuilderContext)" /> method to parse the expression string at design time, and then calls the <see cref="M:System.Web.UI.Design.ConnectionStringsExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method with the parsed expression data. The visual designer uses the evaluated expression result to assign control property values that are rendered on the design surface.</para> + <para>At run time, the page parser uses the <see cref="M:System.Web.Compilation.ConnectionStringsExpressionBuilder.EvaluateExpression(System.Object,System.Web.UI.BoundPropertyEntry,System.Object,System.Web.Compilation.ExpressionBuilderContext)" /> and <see cref="M:System.Web.Compilation.ConnectionStringsExpressionBuilder.GetCodeExpression(System.Web.UI.BoundPropertyEntry,System.Object,System.Web.Compilation.ExpressionBuilderContext)" /> methods of the corresponding <see cref="T:System.Web.Compilation.ConnectionStringsExpressionBuilder" /> implementation to evaluate an expression and provide the run-time value for an associated control property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Evaluates a connection string expression and provides the design-time value for a control property.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />A connection string expression to evaluate. The expression does not include the ConnectionStrings expression prefix.</param> + <param name="parseTimeData"> + <attribution license="cc4" from="Microsoft" modified="false" />An object containing additional parsing information for evaluating the expression.</param> + <param name="propertyType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the control property.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -64,16 +87,24 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ConnectionStringsExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns an editor sheet implementation for connection string expressions. The editor sheet for connection string expressions allows users to select a connection name and type, based on the current connection strings that are defined in the <format type="text/html"><a href="b6ffbb2e-a4d1-410e-8f7e-9755e92c65de">connectionStrings</a></format> section of the Web configuration file. Once users have selected the connection expression properties, the editor sheet implementation combines the connection name and type into a connection string expression, which is returned to the visual designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an expression editor sheet for a connection string expression.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />The expression string set for a control property, used to initialize the expression editor sheet. The expression does not include the ConnectionStrings expression prefix.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContainerControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContainerControlDesigner.xml index 02bbd295b5b..461ea21a2ea 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContainerControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContainerControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ContainerControlDesigner" FullName="System.Web.UI.Design.ContainerControlDesigner"> <TypeSignature Language="C#" Value="public class ContainerControlDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -9,8 +10,39 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class provides a base designer class for controls that can be modified on the design surface. This includes controls that contain child controls or editable inner properties. The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> provides a single framed region to represent the control, and automatically handles rendering the control at design time.</para> + <para>Apply the <see cref="T:System.Web.UI.ParseChildrenAttribute" /> attribute on the associated control to determine the design-time behavior of the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" />. Apply the <see cref="T:System.Web.UI.ParseChildrenAttribute" /> settings on the associated control as follows: </para> + <list type="bullet"> + <item> + <para>false to indicate that the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> represents the contents of the editable design region as child controls. </para> + </item> + <item> + <para>true to indicate that the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> represents the contents of the editable design region as editable inner properties of the control.</para> + </item> + </list> + <para>Control developers can derive and extend a custom designer from one of several base designers depending on the kind of control that is being developed, as defined in the following list:</para> + <list type="bullet"> + <item> + <para>Controls that allow child controls to be added to it at design time can derive from the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class. For example, the <see cref="T:System.Web.UI.Design.WebControls.PanelContainerDesigner" /> class is derived from the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class and represents a <see cref="T:System.Web.UI.WebControls.Panel" /> control on the design surface.</para> + </item> + <item> + <para>Controls that have one or more child controls, and might also have an editable designer region where controls can be added at design time, can derive from the <see cref="T:System.Web.UI.Design.WebControls.CompositeControlDesigner" /> class.</para> + </item> + <item> + <para>Controls that require custom design-time processing can derive from the base <see cref="T:System.Web.UI.Design.ControlDesigner" /> class.</para> + </item> + </list> + <block subset="none" type="note"> + <para> The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class replaces the obsolete <see cref="T:System.Web.UI.Design.ReadWriteControlDesigner" /> class.</para> + </block> + <para>Use the <see cref="T:System.ComponentModel.DesignerAttribute" /> attribute to associate a custom designer class together with a custom control implementation. For detailed information about how to use control designers with custom controls, see <format type="text/html"><a href="27e44af0-6e12-4b7d-b17f-db35f1b6a052">Walkthrough: Creating a Basic Control Designer for a Web Server Control</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides designer functionality for controls that contain child controls or properties that can be modified at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +53,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="AddDesignTimeCssAttributes"> @@ -38,9 +73,17 @@ <Parameter Name="styleAttributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="styleAttributes">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ContainerControlDesigner.AddDesignTimeCssAttributes(System.Collections.IDictionary)" /> method adds a set of style attributes for the design-time representation of the control. The style attribute values are added to the <paramref name="styleAttributes" /> collection, keyed by the style attribute name. For example, you can access the height value in the collection as styleAttributes["height"] for C# or styleAttributes("height") for Microsoft Visual Basic.</para> + <para>If the associated control is not derived from the <see cref="T:System.Web.UI.WebControls.WebControl" /> class, the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.AddDesignTimeCssAttributes(System.Collections.IDictionary)" /> method does not add attribute values to the <paramref name="styleAttributes" /> collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the style attributes for the control at design time.</para> + </summary> + <param name="styleAttributes"> + <attribution license="cc4" from="Microsoft" modified="false" />A keyed collection of style attributes.</param> </Docs> </Member> <Member MemberName="AllowResize"> @@ -53,9 +96,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The base implementation for the <see cref="P:System.Web.UI.Design.ContainerControlDesigner.AllowResize" /> property returns true. This indicates that the designer supports resizing of the control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating if the control can be resized at design time.</para> + </summary> </Docs> </Member> <Member MemberName="FrameCaption"> @@ -68,9 +117,16 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ContainerControlDesigner.FrameCaption" /> string is the caption that is displayed in the frame around the editable region of the control on the design surface.</para> + <para>The default caption for a <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> frame is the <see cref="P:System.Web.UI.Design.ControlDesigner.ID" /> property of the designer instance. This is typically the same as the run-time <see cref="P:System.Web.UI.Control.ID" /> property of the control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption that is displayed for a control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="FrameStyle"> @@ -83,9 +139,15 @@ <ReturnType>System.Web.UI.WebControls.Style</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ContainerControlDesigner.FrameStyle" /> property indicates the style properties of the frame around the editable region of the control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the style that is applied to the control frame at design time.</para> + </summary> </Docs> </Member> <Member MemberName="GetDesignTimeCssAttributes"> @@ -99,9 +161,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeCssAttributes" /> method returns a collection of style attributes for the design-time representation of the control.</para> + <para>To examine a style attribute value at design time for a control, use the style attribute name as a key to the returned collection. Style attribute values are stored as strings in the collection. For example, you can access the height value in the collection as styleAttributes["height"] for C# or styleAttributes("height") for Microsoft Visual Basic.</para> + <para>If the associated control is not derived from the <see cref="T:System.Web.UI.WebControls.WebControl" /> class, the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeCssAttributes" /> method returns an empty collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the collection of style attributes for the control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="GetDesignTimeHtml"> @@ -117,10 +187,18 @@ <Parameter Name="regions" Type="System.Web.UI.Design.DesignerRegionCollection" /> </Parameters> <Docs> - <param name="regions">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method to get the HTML for the control. Child controls that are contained in the editable design region are rendered using their associated control designers.</para> + <para>The <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method initializes a new <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> object for the editable region of associated control, and then returns the region through the <paramref name="regions" /> collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the HTML markup that is used to represent the control at design time.</para> + </summary> + <param name="regions"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection of designer regions.</param> </Docs> </Member> <Member MemberName="GetEditableDesignerRegionContent"> @@ -136,10 +214,17 @@ <Parameter Name="region" Type="System.Web.UI.Design.EditableDesignerRegion" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class implements a single designer region instead of a collection of designer regions. Therefore, the <paramref name="region" /> parameter is ignored, and the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion)" /> method returns the content for the single designer region that is contained in the control designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the content for the editable region of the control at design time.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />An editable design region contained within the control.</param> </Docs> </Member> <Member MemberName="GetPersistenceContent"> @@ -153,9 +238,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetPersistenceContent" /> method returns null to indicate that the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class does not have persisted inner content.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the persistable content of the control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="SetEditableDesignerRegionContent"> @@ -172,11 +263,19 @@ <Parameter Name="content" Type="System.String" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <param name="content">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class implements a single designer region instead of a collection of designer regions. Therefore, the <paramref name="region" /> parameter is ignored, and the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.SetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" /> method sets the content for the single designer region that is contained in the control designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the content for the editable region of the control at design time.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />An editable design region contained within the control.</param> + <param name="content"> + <attribution license="cc4" from="Microsoft" modified="false" />Content to assign for the editable design region.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContentDefinition.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContentDefinition.xml index e4d1b0f5581..581262c9406 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContentDefinition.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContentDefinition.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ContentDefinition" FullName="System.Web.UI.Design.ContentDefinition"> <TypeSignature Language="C#" Value="public class ContentDefinition" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a property structure that defines Web content at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,11 +29,17 @@ <Parameter Name="designTimeHtml" Type="System.String" /> </Parameters> <Docs> - <param name="id">To be added.</param> - <param name="content">To be added.</param> - <param name="designTimeHtml">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new instance of the <see cref="T:System.Web.UI.Design.ContentDefinition" /> class.</para> + </summary> + <param name="id"> + <attribution license="cc4" from="Microsoft" modified="false" />A string identifier for the content.</param> + <param name="content"> + <attribution license="cc4" from="Microsoft" modified="false" />The default HTML markup content.</param> + <param name="designTimeHtml"> + <attribution license="cc4" from="Microsoft" modified="false" />The design-time HTML markup content.</param> </Docs> </Member> <Member MemberName="ContentPlaceHolderID"> @@ -42,9 +52,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the ID of the <see cref="T:System.Web.UI.WebControls.ContentPlaceHolder" /> control that is associated with the current content.</para> + </summary> </Docs> </Member> <Member MemberName="DefaultContent"> @@ -57,9 +70,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the default HTML markup for the content.</para> + </summary> </Docs> </Member> <Member MemberName="DefaultDesignTimeHtml"> @@ -72,10 +88,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the HTML markup to represent the content at design time.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContentDesignerState.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContentDesignerState.xml index 44610d5f0ef..2265df40022 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContentDesignerState.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContentDesignerState.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ContentDesignerState" FullName="System.Web.UI.Design.ContentDesignerState"> <TypeSignature Language="C#" Value="public enum ContentDesignerState" /> <AssemblyInfo> @@ -8,8 +9,11 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enumerates the possible settings for the state of a <see cref="T:System.Web.UI.Design.WebControls.ContentDesigner" /> control at design time.</para> + </summary> </Docs> <Members> <Member MemberName="ShowDefaultContent"> @@ -22,7 +26,10 @@ <ReturnType>System.Web.UI.Design.ContentDesignerState</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The associated control displays the default content.</para> + </summary> </Docs> </Member> <Member MemberName="ShowUserContent"> @@ -35,8 +42,11 @@ <ReturnType>System.Web.UI.Design.ContentDesignerState</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The associated control displays the user content.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlDesigner.xml index a9392700c54..bdb262513db 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ControlDesigner" FullName="System.Web.UI.Design.ControlDesigner"> <TypeSignature Language="C#" Value="public class ControlDesigner : System.Web.UI.Design.HtmlControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,128 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class provides a base control designer class that can be inherited from and extended to provide design-time support for a Web server control in a design host, such as vsprvslong.</para> + <para>The object model for working with design-time rendering is improved over earlier versions, with the following new base classes to provide access to the simplified object model: </para> + <list type="bullet"> + <item> + <para> + <see cref="T:System.Web.UI.Design.ControlDesigner" />, which is not new, but has been greatly improved.</para> + </item> + <item> + <para> + <see cref="T:System.Web.UI.Design.ContainerControlDesigner" />.</para> + </item> + <item> + <para> + <see cref="T:System.Web.UI.Design.WebControls.CompositeControlDesigner" />.</para> + </item> + </list> + <format type="text/html"> + <h2>Automatic Formatting</h2> + </format> + <para>You can create a variety of automatic and pre-defined formats that can simplify the process of page developers who are applying complex style changes to custom Web server controls. For example, the <see cref="T:System.Web.UI.Design.WebControls.TableDesigner" /> control, which derives from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class, provides many automatic formats from which to choose. To implement and provide automatic formatting in your custom controls, use the following features:</para> + <list type="bullet"> + <item> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.AutoFormats" /> property.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnAutoFormatApplied(System.Web.UI.Design.DesignerAutoFormat)" /> method.</para> + </item> + <item> + <para>The <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> class.</para> + </item> + <item> + <para>The <see cref="T:System.Web.UI.Design.DesignerAutoFormatStyle" /> class.</para> + </item> + </list> + <format type="text/html"> + <h2>Action Lists (Smart Tags)</h2> + </format> + <para>Action lists are menus of important or widely used tasks that a page developer who uses a control can perform in a design-time user interface (UI), such as vsprvslong. For example, the design-time view of your control could provide a menu of available tasks. This includes a task to format the control automatically. To learn about action lists, start with the following features:</para> + <list type="bullet"> + <item> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.ActionLists" /> property.</para> + </item> + <item> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class.</para> + </item> + <item> + <para>The <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method.</para> + </item> + <item> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> class.</para> + </item> + <item> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> class.</para> + </item> + <item> + <para>The <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class.</para> + </item> + </list> + <format type="text/html"> + <h2>Control Designer Regions</h2> + </format> + <para>Regions are editable areas in the design-time view of a Web server control. This feature offers WYSIWYG-like editing of the template content, inner controls, and properties at design time. You can have the control designer create controls in regions or you can use the Toolbox to drag and drop controls into regions. Regions are managed with the following features:</para> + <list type="bullet"> + <item> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method.</para> + </item> + <item> + <para>The <see cref="T:System.Web.UI.Design.DesignerRegion" /> class.</para> + </item> + <item> + <para>The <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> class.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.GetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion)" /> method.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.SetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" /> method.</para> + </item> + </list> + <format type="text/html"> + <h2>Templates</h2> + </format> + <para>The model for creating a UI for design-time editing of templated controls, such as the <see cref="T:System.Web.UI.WebControls.GridView" /> control, has been greatly improved from earlier versions. You can create complex custom controls that include templates for various parts of the control, and your custom control designer can help page developers who are modifying templates with the following features:</para> + <list type="bullet"> + <item> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property.</para> + </item> + <item> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.InTemplateMode" /> property.</para> + </item> + <item> + <para>The <see cref="T:System.Web.UI.Design.TemplateGroup" /> class.</para> + </item> + </list> + <format type="text/html"> + <h2>Design-Time Rendering</h2> + </format> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class has the following methods to support design-time rendering of the Web server control. Most of these methods are the same as in earlier versions:</para> + <list type="bullet"> + <item> + <para>The <see cref="Overload:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" /> method.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.GetEmptyDesignTimeHtml" /> method.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.GetErrorDesignTimeHtml(System.Exception)" /> method.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.UpdateDesignTimeHtml" /> method.</para> + </item> + <item> + <para>The <see cref="Overload:System.Web.UI.Design.ControlDesigner.CreatePlaceHolderDesignTimeHtml" /> method.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base control designer class for extending the design-mode behavior of a Web server control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +140,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,9 +161,12 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the action list collection for the control designer.</para> + </summary> </Docs> </Member> <Member MemberName="AllowResize"> @@ -49,9 +176,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the control can be resized in the design-time environment.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -68,9 +198,15 @@ <ReturnType>System.Web.UI.Design.DesignerAutoFormatCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A complete Web server control includes not only the control, but also, possibly, a corresponding control designer class that is derived from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class and a formatting class that is derived from the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> class. The <see cref="P:System.Web.UI.Design.ControlDesigner.AutoFormats" /> property is a collection of instances of the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> class. For a working example of automatic formatting in vsprvslong, see <see cref="T:System.Web.UI.WebControls.Calendar" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the collection of predefined automatic formatting schemes to display in the <ui>Auto Format</ui> dialog box for the associated control at design time. </para> + </summary> </Docs> </Member> <Member MemberName="CreateErrorDesignTimeHtml"> @@ -86,10 +222,27 @@ <Parameter Name="errorMessage" Type="System.String" /> </Parameters> <Docs> - <param name="errorMessage">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.ControlDesigner.CreateErrorDesignTimeHtml(System.String)" /> method to create HTML markup to display an error message for a control at design time. The value for <paramref name="errorMessage" /> specifies a localized string that is displayed to the user of the control at design time.</para> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.CreateErrorDesignTimeHtml(System.String)" /> method returns a table with two rows, as follows: </para> + <list type="bullet"> + <item> + <para>The first row contains the type name and site name for the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Component" /> property of the <see cref="T:System.Web.UI.Design.ControlDesigner" /> object.</para> + </item> + <item> + <para>The second row contains the input error message string.</para> + </item> + </list> + <para>To generate HTML markup for an error message with an associated exception, use the <see cref="M:System.Web.UI.Design.ControlDesigner.CreateErrorDesignTimeHtml(System.String,System.Exception)" /> overload. To generate HTML markup for an exception without specifying a localized error message, use the <see cref="M:System.Web.UI.Design.ControlDesigner.GetErrorDesignTimeHtml(System.Exception)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates HTML markup to display a specified error message at design time.</para> + </summary> + <param name="errorMessage"> + <attribution license="cc4" from="Microsoft" modified="false" />The error message to include in the generated HTML markup.</param> </Docs> </Member> <Member MemberName="CreateErrorDesignTimeHtml"> @@ -106,11 +259,29 @@ <Parameter Name="e" Type="System.Exception" /> </Parameters> <Docs> - <param name="errorMessage">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.ControlDesigner.CreateErrorDesignTimeHtml(System.String,System.Exception)" /> method to provide simple HTML markup that can be used to display error and exception details for a control at design time. The value for <paramref name="errorMessage" /> specifies a localized string that is displayed to the user of the control at design time.</para> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.CreateErrorDesignTimeHtml(System.String,System.Exception)" /> method returns a table with two rows, as follows: </para> + <list type="bullet"> + <item> + <para>The first row contains the type name and site name for the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Component" /> property of the <see cref="T:System.Web.UI.Design.ControlDesigner" />object.</para> + </item> + <item> + <para>The second row contains the input error message and the <see cref="P:System.Exception.Message" /> string of the exception.</para> + </item> + </list> + <para>To generate HTML markup for an error message without specifying an exception, use the <see cref="M:System.Web.UI.Design.ControlDesigner.CreateErrorDesignTimeHtml(System.String)" /> overload. To generate HTML markup for an exception without specifying a localized error message, use the <see cref="M:System.Web.UI.Design.ControlDesigner.GetErrorDesignTimeHtml(System.Exception)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates the HTML markup to display a specified exception error message at design time.</para> + </summary> + <param name="errorMessage"> + <attribution license="cc4" from="Microsoft" modified="false" />The error message to include in the generated HTML string.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The exception to include in the generated HTML string.</param> </Docs> </Member> <Member MemberName="CreatePlaceHolderDesignTimeHtml"> @@ -121,9 +292,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a simple rectangular placeholder representation that displays the type and ID of the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -140,10 +314,14 @@ <Parameter Name="instruction" Type="System.String" /> </Parameters> <Docs> - <param name="instruction">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a simple rectangular placeholder representation that displays the type and ID of the control, and also additional specified instructions or information.</para> + </summary> + <param name="instruction"> + <attribution license="cc4" from="Microsoft" modified="false" />A string that contains text and markup to add to the HTML output. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -161,9 +339,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a copy of the associated control for viewing or rendering on the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="DataBindingsEnabled"> @@ -176,9 +357,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether data binding is supported by the containing region for the associated control.</para> + </summary> </Docs> </Member> <Member MemberName="DesignerState"> @@ -191,9 +375,16 @@ <ReturnType>System.Web.UI.Design.ControlDesignerState</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The values for the <see cref="P:System.Web.UI.Design.ControlDesigner.DesignerState" /> property are persisted even if the user switches from Design to Source view, or reloads the document, or closes and reopens the design host.</para> + <para>You can get and set values in the returned object as you would in an IDictionary object, with the values automatically persisted.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an object that is used to persist data for the associated control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="DesignTimeElementView"> @@ -203,9 +394,17 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.DesignTimeElementView" /> property is obsolete and there is no replacement for the functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the view-control object for the control designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -224,9 +423,18 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation of the <see cref="P:System.Web.UI.Design.ControlDesigner.DesignTimeHtmlRequiresLoadComplete" /> property returns false.</para> + <block subset="none" type="note"> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.DesignTimeHtmlRequiresLoadComplete" /> property is obsolete. Use the <see cref="M:System.Web.UI.Design.ControlDesigner.SetViewFlags(System.Web.UI.Design.ViewFlags,System.Boolean)" /> method for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the design host must finish loading before the <see cref="Overload:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" /> method can be called.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -249,9 +457,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the coordinates of the rectangle representing the boundaries for the control as displayed on the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="GetDesignTimeHtml"> @@ -262,9 +473,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup that is used to represent the control at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -284,10 +498,18 @@ <Parameter Name="regions" Type="System.Web.UI.Design.DesignerRegionCollection" /> </Parameters> <Docs> - <param name="regions">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The design host calls the <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method to get the design-time HTML markup and the current list of control designer regions. Using the DesignerRegionCollection, the design host can then request the markup for each editable control designer region.</para> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method is provided for a derived control designer, such as the <see cref="T:System.Web.UI.Design.WebControls.GridViewDesigner" /> class, that must process the content for the region before calling the <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup to display the control and populates the collection with the current control designer regions.</para> + </summary> + <param name="regions"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection of control designer regions for the associated control.</param> </Docs> </Member> <Member MemberName="GetDesignTimeResourceProviderFactory"> @@ -303,10 +525,18 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A resource provider factory creates resource providers and resource writers, depending on the current settings in the system.web/globalization section of the configuration file (either the Machine.config or Web.config files for both global and local resources). If no globalization settings are found, the <paramref name="serviceProvider" /> parameter is used to create a <see cref="T:System.Web.UI.Design.DesignTimeResourceProviderFactory" /> object using the default implementation for the design host.</para> + <para>Typically, control developers will not override the <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeResourceProviderFactory(System.IServiceProvider)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an appropriate resource provider factory, depending on the globalization settings in the configuration file for the site.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> object that can retrieve global and local services.</param> </Docs> </Member> <Member MemberName="GetEditableDesignerRegionContent"> @@ -322,10 +552,18 @@ <Parameter Name="region" Type="System.Web.UI.Design.EditableDesignerRegion" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.GetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion)" /> method returns an empty string (""). </para> + <para>Classes deriving from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class can support region-based editing on the design surface and override the <see cref="M:System.Web.UI.Design.ControlDesigner.GetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion)" /> method to return the content for a specified region.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the content for an editable region of the design-time view of the associated control.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> object to get content for.</param> </Docs> </Member> <Member MemberName="GetEmptyDesignTimeHtml"> @@ -336,9 +574,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default behavior of the <see cref="M:System.Web.UI.Design.ControlDesigner.GetEmptyDesignTimeHtml" /> method is to return a string that contains the name of the component. The <see cref="M:System.Web.UI.Design.ControlDesigner.GetEmptyDesignTimeHtml" /> method should be called in the implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" /> method when there is no design-time HTML markup.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup to represent a Web server control at design time that will have no visual representation at run time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -355,10 +599,17 @@ <Parameter Name="e" Type="System.Exception" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.GetErrorDesignTimeHtml(System.Exception)" /> method is typically called, if an exception is thrown in the <see cref="Overload:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup that provides information about the specified exception. </para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The exception that occurred. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -376,9 +627,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the persistable inner HTML markup of the control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="GetPersistInnerHtml"> @@ -389,9 +643,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.GetPersistInnerHtml" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.ControlDesigner.GetPersistenceContent" /> method for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the persistable inner HTML markup of the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -414,9 +676,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves an object that contains the design-time markup for the content and regions of the associated control.</para> + </summary> </Docs> </Member> <Member MemberName="GetViewRendering"> @@ -432,10 +697,14 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves an object that contains the design-time markup for the content and regions of the specified control.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Control" /> object.</param> </Docs> </Member> <Member MemberName="GetViewRendering"> @@ -451,10 +720,14 @@ <Parameter Name="designer" Type="System.Web.UI.Design.ControlDesigner" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves an object that contains the design-time markup for the content and regions of the associated control for the specified control designer.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />A control designer that derives from <see cref="T:System.Web.UI.Design.ControlDesigner" />.</param> </Docs> </Member> <Member MemberName="HidePropertiesInTemplateMode"> @@ -467,9 +740,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The ID property is never hidden. The <see cref="M:System.Web.UI.Design.ControlDesigner.PreFilterProperties(System.Collections.IDictionary)" /> method uses the <see cref="P:System.Web.UI.Design.ControlDesigner.HidePropertiesInTemplateMode" /> property to determine whether properties, other than the ID property, should be hidden from the property grids while the control is in template editing mode.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the properties of the associated control are hidden when the control is in template mode.</para> + </summary> </Docs> </Member> <Member MemberName="ID"> @@ -479,9 +758,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.ID" /> property is used internally within the control designer and for interaction with the Properties window. The <see cref="P:System.Web.UI.Design.ControlDesigner.ID" /> property shadows the run-time <see cref="P:System.Web.UI.Control.ID" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the ID string for the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -498,9 +783,27 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.Initialize(System.ComponentModel.IComponent)" /> method is called by the design host to complete the following actions: </para> + <list type="bullet"> + <item> + <para>Load the control designer with the component to design.</para> + </item> + <item> + <para>Set up the view on the control using the <see cref="M:System.Web.UI.Design.ControlDesigner.SetViewFlags(System.Web.UI.Design.ViewFlags,System.Boolean)" /> method.</para> + </item> + <item> + <para>Verify that the associated control is of the right type.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the control designer and loads the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The control being designed. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -517,9 +820,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A Web server control is in template mode when a read-only template is currently being viewed or an editable template is being edited in a design host such as vsprvslong.</para> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default <see cref="T:System.Web.UI.Design.ViewEventHandler" /> object to update the <see cref="P:System.Web.UI.Design.ControlDesigner.InTemplateMode" /> value when the template mode changes for the associated control. Custom designers that are derived from the <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> class can override the <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> method to perform additional processing when the template editing mode changes for a control in the design host.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the control is in either template viewing or editing mode in the design host. The <see cref="P:System.Web.UI.Design.ControlDesigner.InTemplateMode" /> property is read-only.</para> + </summary> </Docs> </Member> <Member MemberName="Invalidate"> @@ -533,8 +843,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>To enable the control designer to handle paint events, use the <see cref="M:System.Web.UI.Design.ControlDesigner.SetViewFlags(System.Web.UI.Design.ViewFlags,System.Boolean)" /> method in the <see cref="M:System.Web.UI.Design.ControlDesigner.Initialize(System.ComponentModel.IComponent)" /> method.</para> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.Invalidate" /> method provides the design host with a way to instruct the control designer to redraw the control. Essentially, this is the same as calling <see cref="M:System.Web.UI.Design.ControlDesigner.UpdateDesignTimeHtml" /> method, because it causes the whole control to be redrawn.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Invalidates the whole area of the control that is displayed on the design surface and signals the control designer to redraw the control.</para> + </summary> </Docs> </Member> <Member MemberName="Invalidate"> @@ -550,9 +867,17 @@ <Parameter Name="rectangle" Type="System.Drawing.Rectangle" /> </Parameters> <Docs> - <param name="rectangle">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>To enable the control designer to handle paint events, use the <see cref="M:System.Web.UI.Design.ControlDesigner.SetViewFlags(System.Web.UI.Design.ViewFlags,System.Boolean)" /> method in the <see cref="M:System.Web.UI.Design.ControlDesigner.Initialize(System.ComponentModel.IComponent)" /> method.</para> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.Invalidate(System.Drawing.Rectangle)" /> method provides the design host with a way to instruct the control designer to redraw a specific part of the control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Invalidates the specified area of the control that is displayed on the design surface and signals the control designer to redraw the control.</para> + </summary> + <param name="rectangle"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Rectangle" /> object that represents the area to invalidate, relative to the upper-left corner of the control. </param> </Docs> </Member> <Member MemberName="InvokeTransactedChange"> @@ -571,12 +896,23 @@ <Parameter Name="description" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="callback">To be added.</param> - <param name="context">To be added.</param> - <param name="description">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.InvokeTransactedChange(System.ComponentModel.IComponent,System.Web.UI.Design.TransactedChangeCallback,System.Object,System.String)" /> method notifies the design host, which is determined by the <see cref="P:System.Web.UI.Control.Site" /> property of <paramref name="component" />, that a change is occurring in the associated control and, if the change is not canceled by the design host, invokes the specified <paramref name="callback" /> using the specified <paramref name="context" />, and then notifies the design host that the change has completed.</para> + <para>If the design host or the associated control throws a static Canceled exception field of a <see cref="T:System.ComponentModel.Design.CheckoutException" /> exception, the transaction is canceled without invoking <paramref name="callback" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Wraps a series of changes into a transaction, using the specified parameters that can be rolled back as a unit with the undo functionality of the design host.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The control associated with the control designer.</param> + <param name="callback"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.TransactedChangeCallback" /> object representing a function to call in the control designer as part of the transaction.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An object that contains the argument for callback.</param> + <param name="description"> + <attribution license="cc4" from="Microsoft" modified="false" />A description of the effect of allowing the transaction to complete, which is used by the design host to give the user an opportunity to cancel the transaction.</param> </Docs> </Member> <Member MemberName="InvokeTransactedChange"> @@ -596,13 +932,25 @@ <Parameter Name="member" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="callback">To be added.</param> - <param name="context">To be added.</param> - <param name="description">To be added.</param> - <param name="member">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.InvokeTransactedChange(System.ComponentModel.IComponent,System.Web.UI.Design.TransactedChangeCallback,System.Object,System.String)" /> method notifies the design host, which is determined by the <see cref="P:System.Web.UI.Control.Site" /> property of <paramref name="component" />, that a change is occurring to the specified <paramref name="member" /> (property or method) of the associated control and, if the change is not canceled by the design host, invokes the specified <paramref name="callback" /> using the specified <paramref name="context" /> as the argument, and then notifies the design host that the change has completed.</para> + <para>If the design host or associated control throws a static Canceled exception field of a <see cref="T:System.ComponentModel.Design.CheckoutException" /> exception, the transaction is canceled without invoking <paramref name="callback" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Wraps a series of changes into a transaction, using the specified parameters that can be rolled back as a unit with the undo functionality of the design host.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The control associated with the control designer.</param> + <param name="callback"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.TransactedChangeCallback" /> object representing a function to call in the control designer as part of the transaction.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An object that contains the argument for callback.</param> + <param name="description"> + <attribution license="cc4" from="Microsoft" modified="false" />A description of the effect of allowing the transaction to complete, which is used by the design host to give the user an opportunity to cancel the transaction.</param> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.MemberDescriptor" /> object (typically, either an <see cref="T:System.ComponentModel.EventDescriptor" /> or a <see cref="T:System.ComponentModel.PropertyDescriptor" /> object) that describes the member of the associated control that is being invoked as part of the transaction.</param> </Docs> </Member> <Member MemberName="InvokeTransactedChange"> @@ -623,14 +971,27 @@ <Parameter Name="member" Type="System.ComponentModel.MemberDescriptor" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <param name="component">To be added.</param> - <param name="callback">To be added.</param> - <param name="context">To be added.</param> - <param name="description">To be added.</param> - <param name="member">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.InvokeTransactedChange(System.ComponentModel.IComponent,System.Web.UI.Design.TransactedChangeCallback,System.Object,System.String)" /> method notifies the design host, which is represented by <paramref name="serviceProvider" />, that a change is occurring to the specified <paramref name="member" /> (property or method) of the associated control and, if the change is not canceled by the design host, invokes the specified <paramref name="callback" /> using the specified <paramref name="context" /> as the argument, and then notifies the design host that the change has completed.</para> + <para>If the design host or the associated control throws a static Canceled exception field of a <see cref="T:System.ComponentModel.Design.CheckoutException" /> exception, the transaction is canceled without invoking <paramref name="callback" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Wraps a series of changes into a transaction, using the specified parameters that can be rolled back as a unit with the undo functionality of the design host.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> object representing the design host that provides control designer services for the associated control.</param> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The control associated with the control designer.</param> + <param name="callback"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.TransactedChangeCallback" /> object representing a function to call in the control designer as part of the transaction.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An object that contains the argument for callback.</param> + <param name="description"> + <attribution license="cc4" from="Microsoft" modified="false" />A description of the effect of allowing the transaction to complete, which is used by the design host to give the user an opportunity to cancel the transaction.</param> + <param name="member"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.MemberDescriptor" /> object (typically either an <see cref="T:System.ComponentModel.EventDescriptor" /> or a <see cref="T:System.ComponentModel.PropertyDescriptor" /> object) that describes the member of the associated control that is being invoked as part of the transaction.</param> </Docs> </Member> <Member MemberName="IsDirty"> @@ -640,9 +1001,17 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.IsDirty" /> property is obsolete. Use the <see cref="P:System.Web.UI.Design.IControlDesignerTag.IsDirty" /> property and the <see cref="M:System.Web.UI.Design.IControlDesignerTag.SetDirty(System.Boolean)" /> method on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value indicating whether the Web server control has been marked as changed.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -664,10 +1033,19 @@ <Parameter Name="propName" Type="System.String" /> </Parameters> <Docs> - <param name="propName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.IsPropertyBound(System.String)" /> method is obsolete. Use the <see cref="M:System.Web.UI.DataBindingCollection.Contains(System.String)" /> method on the <see cref="P:System.Web.UI.Design.HtmlControlDesigner.DataBindings" /> property for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves a value indicating whether the specified property on the associated control is data-bound.</para> + </summary> + <param name="propName"> + <attribution license="cc4" from="Microsoft" modified="false" />The property to test for data binding. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -692,9 +1070,16 @@ <Parameter Name="resourceWriter" Type="System.Web.UI.Design.IDesignTimeResourceWriter" /> </Parameters> <Docs> - <param name="resourceWriter">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.Localize(System.Web.UI.Design.IDesignTimeResourceWriter)" /> method is called by the design host to create resource entries for each property that is marked with a <see cref="T:System.ComponentModel.LocalizableAttribute" /> object and any properties that use an explicit resource expression as a value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Uses the provided resource writer to persist the localizable properties of the associated control to a resource in the design host.</para> + </summary> + <param name="resourceWriter"> + <attribution license="cc4" from="Microsoft" modified="false" />An object derived from the <see cref="T:System.Web.UI.Design.IDesignTimeResourceWriter" /> object that is used to write resources into the design-time response stream.</param> </Docs> </Member> <Member MemberName="OnAutoFormatApplied"> @@ -710,9 +1095,17 @@ <Parameter Name="appliedAutoFormat" Type="System.Web.UI.Design.DesignerAutoFormat" /> </Parameters> <Docs> - <param name="appliedAutoFormat">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnAutoFormatApplied(System.Web.UI.Design.DesignerAutoFormat)" /> method is called after a <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object has applied a predefined format to the associated control. A <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object defines the automatic formatting scheme name and style settings that are applied to the control.</para> + <para>Classes deriving from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class override the <see cref="M:System.Web.UI.Design.ControlDesigner.OnAutoFormatApplied(System.Web.UI.Design.DesignerAutoFormat)" /> method to perform additional processing when an automatic formatting scheme is applied to the associated control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when a predefined, automatic formatting scheme has been applied to the associated control.</para> + </summary> + <param name="appliedAutoFormat"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object that defines a style.</param> </Docs> </Member> <Member MemberName="OnBehaviorAttached"> @@ -723,8 +1116,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnBehaviorAttached" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.IControlDesignerTag.SetAttribute(System.String,System.String)" /> and <see cref="M:System.Web.UI.Design.IControlDesignerTag.GetAttribute(System.String)" /> methods on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the control designer is attached to a Behavior object.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -740,9 +1141,19 @@ <Parameter Name="propName" Type="System.String" /> </Parameters> <Docs> - <param name="propName">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnBindingsCollectionChanged(System.String)" /> method is called when the data-binding collection has been changed by an external caller.</para> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnBindingsCollectionChanged(System.String)" /> method is obsolete. Use the <see cref="E:System.Web.UI.DataBindingCollection.Changed" /> event on the <see cref="P:System.Web.UI.Design.HtmlControlDesigner.DataBindings" /> collection for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the data-binding collection changes.</para> + </summary> + <param name="propName"> + <attribution license="cc4" from="Microsoft" modified="false" />The property to test for changes in its bindings collection. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -767,9 +1178,30 @@ <Parameter Name="e" Type="System.Web.UI.Design.DesignerRegionMouseEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event is raised by the design host for certain actions on a control in the design surface. For example, an event is raised for the following conditions:</para> + <list type="bullet"> + <item> + <para>The user clicks the control.</para> + </item> + <item> + <para>The control designer paints on the design surface.</para> + </item> + <item> + <para>The user enters or exits template editing mode for the control.</para> + </item> + </list> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default delegate to handle the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event. Classes deriving from <see cref="T:System.Web.UI.Design.ControlDesigner" /> override the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method to process events that are raised when the user clicks a control.</para> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> + <para>The default implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method returns without performing any processing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called by the design host when the user clicks the associated control at design time.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.DesignerRegionMouseEventArgs" /> object that specifies the location and, possibly, the control designer region that the user clicked.</param> </Docs> </Member> <Member MemberName="OnComponentChanged"> @@ -783,10 +1215,18 @@ <Parameter Name="ce" Type="System.ComponentModel.Design.ComponentChangedEventArgs" /> </Parameters> <Docs> - <param name="sender">To be added.</param> - <param name="ce">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnComponentChanged(System.Object,System.ComponentModel.Design.ComponentChangedEventArgs)" /> method is called when a property on the associated control is changed. It allows the implementer to do any processing that might be required after a property change. Calling the <see cref="M:System.Web.UI.Design.ControlDesigner.OnComponentChanged(System.Object,System.ComponentModel.Design.ComponentChangedEventArgs)" /> method causes the design host to call the <see cref="Overload:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" /> method. The base implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.OnComponentChanged(System.Object,System.ComponentModel.Design.ComponentChangedEventArgs)" /> method also persists the control in the page markup.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the associated control changes.</para> + </summary> + <param name="sender"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event. </param> + <param name="ce"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.ComponentChangedEventArgs" /> object that contains the event data. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -807,10 +1247,18 @@ <Parameter Name="ce" Type="System.ComponentModel.Design.ComponentChangingEventArgs" /> </Parameters> <Docs> - <param name="sender">To be added.</param> - <param name="ce">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When either the <see cref="Overload:System.Web.UI.Design.ControlDesigner.InvokeTransactedChange" /> or <see cref="M:System.Web.UI.Design.ControlDesigner.Localize(System.Web.UI.Design.IDesignTimeResourceWriter)" /> method is called, the <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentChanging" /> event occurs before any changes are made to the associated control. After the changes are complete, the <see cref="M:System.Web.UI.Design.ControlDesigner.OnComponentChanged(System.Object,System.ComponentModel.Design.ComponentChangedEventArgs)" /> method occurs.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentChanging" /> event for the associated control. </para> + </summary> + <param name="sender"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that is the source of the event.</param> + <param name="ce"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.ComponentChangedEventArgs" /> object that contains the event data.</param> </Docs> </Member> <Member MemberName="OnControlResize"> @@ -821,8 +1269,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnControlResize" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.ControlDesigner.OnComponentChanged(System.Object,System.ComponentModel.Design.ComponentChangedEventArgs)" /> method for equivalent control designer functionality.</para> + </block> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnControlResize" /> method typically is called only by the design-time environment when a user action causes the associated Web server control to be resized. The <see cref="M:System.Web.UI.Design.ControlDesigner.OnControlResize" /> method might be called several times during a resizing process to display the updated size of the control before the resizing is completed. The width and height properties of the control are updated before the <see cref="M:System.Web.UI.Design.ControlDesigner.OnControlResize" /> method is called.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the associated Web server control has been resized in the design host at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -847,9 +1304,30 @@ <Parameter Name="e" Type="System.Windows.Forms.PaintEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event is raised by the design host for certain actions on a control in the design surface. For example, an event is raised for the following conditions:</para> + <list type="bullet"> + <item> + <para>The user clicks the control.</para> + </item> + <item> + <para>The design host requests HTML markup to render the associated control on the design surface.</para> + </item> + <item> + <para>The user enters or exits template editing mode for the control.</para> + </item> + </list> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default delegate to handle the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event. Classes deriving from <see cref="T:System.Web.UI.Design.ControlDesigner" /> should set the <see cref="F:System.Web.UI.Design.ViewFlags.CustomPaint" /> value and override the <see cref="M:System.Web.UI.Design.ControlDesigner.OnPaint(System.Windows.Forms.PaintEventArgs)" /> method to process events that are raised when the design host draws the control on the design surface.</para> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.OnPaint(System.Windows.Forms.PaintEventArgs)" /> method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> + <para>The default implementation of the <see cref="M:System.Web.UI.Design.ControlDesigner.OnPaint(System.Windows.Forms.PaintEventArgs)" /> method returns without performing any processing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the control designer draws the associated control on the design surface, if the <see cref="F:System.Web.UI.Design.ViewFlags.CustomPaint" /> value is true.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.PaintEventArgs" /> object that specifies the graphics and rectangle boundaries used to draw the control.</param> </Docs> </Member> <Member MemberName="PreFilterProperties"> @@ -862,9 +1340,17 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>With the <see cref="M:System.Web.UI.Design.ControlDesigner.PreFilterProperties(System.Collections.IDictionary)" /> method, you can add items to the dictionary of properties that a control designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + <para>The keys in the dictionary of properties are the names of the properties. The objects are of type <see cref="T:System.ComponentModel.PropertyDescriptor" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds properties to or removes properties from the Properties grid in a design host at design time or provides new design-time properties that might correspond to properties on the associated control.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The properties for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -879,8 +1365,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.RaiseResizeEvent" /> method is obsolete and there is no replacement for this feature.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="M:System.Web.UI.Design.ControlDesigner.OnControlResize" /> event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -899,9 +1391,18 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class is read-only, by nature. Read/write features are provided by adding a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object or using base classes, such as the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class.</para> + <block subset="none" type="note"> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.ReadOnly" /> property is obsolete. Derive from the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class to which you can add editable designer regions or from the <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> object to which you can create editable designer regions in templates.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value indicating whether the properties of the control are read-only at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -927,10 +1428,18 @@ <Parameter Name="clone" Type="System.Object" /> </Parameters> <Docs> - <param name="original">To be added.</param> - <param name="clone">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Whenever an item is cloned, there might be some internal data structures, such as meta: attributes, that should be included in the cloned control by the control designer. A page developer might add meta: attributes to the markup of a control and there is no way, nor is there a reason, for the control to distinguish what those tags might be. Therefore, if your control designer provides a way to edit complex properties or formats before applying changes to a page, you would create a clone of the control, pass both the original control and the clone to this <see cref="M:System.Web.UI.Design.ControlDesigner.RegisterClone(System.Object,System.Object)" /> method, and then, when the changes are persisted to the tag, all meta: attributes are also persisted.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Registers internal data in a cloned control.</para> + </summary> + <param name="original"> + <attribution license="cc4" from="Microsoft" modified="false" />The control associated with the control designer.</param> + <param name="clone"> + <attribution license="cc4" from="Microsoft" modified="false" />The cloned copy of the associated control.</param> </Docs> </Member> <Member MemberName="RootDesigner"> @@ -943,9 +1452,15 @@ <ReturnType>System.Web.UI.Design.WebFormsRootDesigner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> property represents the control designer for the Web Forms page that contains the control. Use the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> property to access and manipulate the containing Web Forms page at design time. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the control designer for the Web Forms page that contains the associated control.</para> + </summary> </Docs> </Member> <Member MemberName="SetEditableDesignerRegionContent"> @@ -962,10 +1477,18 @@ <Parameter Name="content" Type="System.String" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <param name="content">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Classes deriving from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class can support region-based editing on the design surface and override the <see cref="M:System.Web.UI.Design.ControlDesigner.SetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" /> method to set the content for a specified region.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the content for an editable region of the control at design time. </para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />An editable design region contained within the control.</param> + <param name="content"> + <attribution license="cc4" from="Microsoft" modified="false" />The content to assign for the editable design region.</param> </Docs> </Member> <Member MemberName="SetRegionContent"> @@ -982,10 +1505,19 @@ <Parameter Name="content" Type="System.String" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <param name="content">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Normally, the <see cref="M:System.Web.UI.Design.ControlDesigner.SetRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" /> method is not overridden in derived designers. The base class causes the design host to call the <see cref="M:System.Web.UI.Design.ControlDesigner.SetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" /> method for the region. Override the <see cref="M:System.Web.UI.Design.ControlDesigner.SetRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" /> method when custom data is required for the control before calling <see cref="M:System.Web.UI.Design.ControlDesigner.SetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" /> method.</para> + <para>Use the <see cref="M:System.Web.UI.Design.ControlDesigner.SetRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" /> method to insert HTML markup into a region of the control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the content for an editable region in the design-time view of the control.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />An editable design region contained within the design-time view of the control.</param> + <param name="content"> + <attribution license="cc4" from="Microsoft" modified="false" />The content to assign for the editable design region.</param> </Docs> </Member> <Member MemberName="SetViewFlags"> @@ -1002,10 +1534,18 @@ <Parameter Name="setFlag" Type="System.Boolean" /> </Parameters> <Docs> - <param name="viewFlags">To be added.</param> - <param name="setFlag">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>There are several flags that can be set. For example, use the <see cref="M:System.Web.UI.Design.ControlDesigner.SetViewFlags(System.Web.UI.Design.ViewFlags,System.Boolean)" /> method to set the <see cref="F:System.Web.UI.Design.ViewFlags.DesignTimeHtmlRequiresLoadComplete" /> value of the current <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> property for the control designer, instead of the obsolete <see cref="P:System.Web.UI.Design.ControlDesigner.DesignTimeHtmlRequiresLoadComplete" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Assigns the specified bitwise <see cref="T:System.Web.UI.Design.ViewFlags" /> enumeration to the specified flag value.</para> + </summary> + <param name="viewFlags"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ViewFlags" /> value.</param> + <param name="setFlag"> + <attribution license="cc4" from="Microsoft" modified="false" />true to set the flag, false to remove the flag.</param> </Docs> </Member> <Member MemberName="Tag"> @@ -1018,9 +1558,15 @@ <ReturnType>System.Web.UI.Design.IControlDesignerTag</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Typically, the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property is used only for communication between the design host and the control designer and is not used by control developers.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an object representing the HTML markup element for the associated control.</para> + </summary> </Docs> </Member> <Member MemberName="TemplateGroups"> @@ -1033,9 +1579,12 @@ <ReturnType>System.Web.UI.Design.TemplateGroupCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of template groups, each containing one or more template definitions.</para> + </summary> </Docs> </Member> <Member MemberName="UpdateDesignTimeHtml"> @@ -1046,8 +1595,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.UpdateDesignTimeHtml" /> method is called by the design host to update the display of the associated Web server control at design time, such as when the control has been modified. Also, a control designer can call the <see cref="M:System.Web.UI.Design.ControlDesigner.UpdateDesignTimeHtml" /> method after modifying values of the control to update the display of the control.</para> + <block subset="none" type="note"> + <para>If you are calling the <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentChanged" /> event, or using the <see cref="T:System.ComponentModel.PropertyDescriptor" /> object to set properties, the <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> interface calls the <see cref="M:System.Web.UI.Design.ControlDesigner.UpdateDesignTimeHtml" /> method for you.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Refreshes the design-time HTML markup for the associated Web server control by calling the <see cref="Overload:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" /> method.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -1064,9 +1622,17 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> property is true, the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> property returns a temporary copy of the control. Changes to the temporary control are not persisted to the document.</para> + <para>If the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> property is false, the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> property returns an instance of the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Component" /> property for the control. Changes to the instance of the control are persisted.</para> + <para>The <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> setting in the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> object is used to set the value of the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> property. Therefore, the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> setting determines the type of control that is returned by the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> property in the base <see cref="T:System.Web.UI.Design.ControlDesigner" /> class. If the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> is not specified in the control designer declaration, the <see cref="T:System.Web.UI.Design.ControlDesigner" /> object behavior is equivalent to specifying the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property as false.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the control designer uses a temporary preview control to generate the design-time HTML markup.</para> + </summary> </Docs> </Member> <Member MemberName="ViewControl"> @@ -1079,9 +1645,18 @@ <ReturnType>System.Web.UI.Control</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> property uses the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> property to determine its return value.</para> + <para>If the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> property is true, the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> property returns a temporary copy of the control. Changes to the temporary control are not persisted. </para> + <para>If the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> property is false, the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> property returns an instance of the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Component" /> property for the control. Changes to the instance of the control are persisted.</para> + <para>The <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> setting in the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> object is used to set the value of the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> property. Therefore, the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> setting determines the type of control that is returned by the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> property in the base <see cref="T:System.Web.UI.Design.ControlDesigner" /> class. If the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> is not specified in the control designer declaration, the <see cref="T:System.Web.UI.Design.ControlDesigner" /> object behavior is equivalent to specifying the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property as false.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a Web server control that can be used for previewing the design-time HTML markup.</para> + </summary> </Docs> </Member> <Member MemberName="ViewControlCreated"> @@ -1094,10 +1669,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 a View control has been created for display on the design surface.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlDesignerState.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlDesignerState.xml index be031168ed9..c8c357137ec 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlDesignerState.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlDesignerState.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ControlDesignerState" FullName="System.Web.UI.Design.ControlDesignerState"> <TypeSignature Language="C#" Value="public sealed class ControlDesignerState" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ControlDesignerState" /> class is a wrapper for the <see cref="T:System.ComponentModel.Design.IComponentDesignerStateService" /> interface, which is the interface between a designer and a design host, such as vsprvslong.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides access to the state of the control designer in the design host through the <see cref="T:System.ComponentModel.Design.IComponentDesignerStateService" /> interface. This class cannot be inherited. </para> + </summary> </Docs> <Members> <Member MemberName="Item"> @@ -33,4 +40,4 @@ </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlLocation.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlLocation.xml index 9b2c0107697..25b8ee2113d 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlLocation.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlLocation.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ControlLocation" FullName="System.Web.UI.Design.ControlLocation"> <TypeSignature Language="C#" Value="public enum ControlLocation" /> <AssemblyInfo> @@ -8,8 +9,14 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ControlLocation" /> enumeration is used by the <see cref="M:System.Web.UI.Design.WebFormsRootDesigner.AddControlToDocument(System.Web.UI.Control,System.Web.UI.Control,System.Web.UI.Design.ControlLocation)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the possible locations for adding a control in a container.</para> + </summary> </Docs> <Members> <Member MemberName="After"> @@ -22,7 +29,10 @@ <ReturnType>System.Web.UI.Design.ControlLocation</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the control after the current selection or current control.</para> + </summary> </Docs> </Member> <Member MemberName="Before"> @@ -35,7 +45,10 @@ <ReturnType>System.Web.UI.Design.ControlLocation</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the control before the current selection or current control.</para> + </summary> </Docs> </Member> <Member MemberName="First"> @@ -48,7 +61,10 @@ <ReturnType>System.Web.UI.Design.ControlLocation</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the control at the start of the document.</para> + </summary> </Docs> </Member> <Member MemberName="FirstChild"> @@ -61,7 +77,10 @@ <ReturnType>System.Web.UI.Design.ControlLocation</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the control as the first child of the selected control, if the selected control is a container control.</para> + </summary> </Docs> </Member> <Member MemberName="Last"> @@ -74,7 +93,10 @@ <ReturnType>System.Web.UI.Design.ControlLocation</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the control at the end of the document.</para> + </summary> </Docs> </Member> <Member MemberName="LastChild"> @@ -87,8 +109,11 @@ <ReturnType>System.Web.UI.Design.ControlLocation</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the control as the last child of the selected control, if the selected control is a container control.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlParser.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlParser.xml index a8558279cf2..5080b162ac8 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlParser.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlParser.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ControlParser" FullName="System.Web.UI.Design.ControlParser"> <TypeSignature Language="C#" Value="public sealed class ControlParser" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The T:System.Web.UI.Design.ControlParser class provides methods that can create a T:System.Web.UI.Control control or T:System.Web.UI.ITemplate interface by parsing a string of markup representing a control or control template.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides methods for creating a Web server <see cref="T:System.Web.UI.Control" /> control or <see cref="T:System.Web.UI.ITemplate" /> interface from a string of markup that represents a persisted control or template.</para> + </summary> </Docs> <Members> <Member MemberName="ParseControl"> @@ -25,11 +32,20 @@ <Parameter Name="controlText" Type="System.String" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <param name="controlText">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlParser.ParseControl(System.ComponentModel.Design.IDesignerHost,System.String)" /> method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.ReferenceManager" /> property of the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> object, or if that is not available, the <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" /> service.</para> + <para>The <see cref="M:System.Web.UI.Design.ControlParser.ParseControl(System.ComponentModel.Design.IDesignerHost,System.String)" /> method throws an exception if the parser cannot build the control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a control from the specified markup using the specified designer host.</para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> instance that is the designer host for the page. </param> + <param name="controlText"> + <attribution license="cc4" from="Microsoft" modified="false" />The HTML markup for the control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -48,12 +64,22 @@ <Parameter Name="directives" Type="System.String" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <param name="controlText">To be added.</param> - <param name="directives">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlParser.ParseControl(System.ComponentModel.Design.IDesignerHost,System.String,System.String)" /> method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.ReferenceManager" /> property of the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> object, or if that is not available, the <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" /> service.</para> + <para>The <see cref="M:System.Web.UI.Design.ControlParser.ParseControl(System.ComponentModel.Design.IDesignerHost,System.String,System.String)" /> method throws an exception if the parser cannot build the control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a control from the specified markup using the specified designer host and directives.</para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> instance that is the designer host for the page.</param> + <param name="controlText"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the HTML markup for the control.</param> + <param name="directives"> + <attribution license="cc4" from="Microsoft" modified="false" />The page directives to include in the code for the control.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -74,11 +100,20 @@ <Parameter Name="controlText" Type="System.String" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <param name="controlText">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlParser.ParseControls(System.ComponentModel.Design.IDesignerHost,System.String)" /> method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.ReferenceManager" /> property of the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> object, or if that is not available, the <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" /> service.</para> + <para>The <see cref="M:System.Web.UI.Design.ControlParser.ParseControls(System.ComponentModel.Design.IDesignerHost,System.String)" /> method throws an exception if the parser cannot build the controls from the <paramref name="controlText" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an array of controls from the specified markup using the specified designer host.</para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> instance that is the designer host for the page.</param> + <param name="controlText"> + <attribution license="cc4" from="Microsoft" modified="false" />A string that represents a collection of markup for controls.</param> </Docs> </Member> <Member MemberName="ParseTemplate"> @@ -92,11 +127,19 @@ <Parameter Name="templateText" Type="System.String" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <param name="templateText">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlParser.ParseTemplate(System.ComponentModel.Design.IDesignerHost,System.String)" /> method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.ReferenceManager" /> property of the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> object, or if that is not available, the <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" /> service.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an <see cref="T:System.Web.UI.ITemplate" /> interface from the specified template markup.</para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> instance that is the designer host for the page. </param> + <param name="templateText"> + <attribution license="cc4" from="Microsoft" modified="false" />A string containing the template markup. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -115,12 +158,21 @@ <Parameter Name="directives" Type="System.String" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <param name="templateText">To be added.</param> - <param name="directives">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlParser.ParseTemplate(System.ComponentModel.Design.IDesignerHost,System.String,System.String)" /> method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.ReferenceManager" /> property of the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> object, or if that is not available, the <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" /> service.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Parses the specified template markup and creates an <see cref="T:System.Web.UI.ITemplate" /> interface.</para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> instance that is the designer host for the page. </param> + <param name="templateText"> + <attribution license="cc4" from="Microsoft" modified="false" />A string containing the template markup. </param> + <param name="directives"> + <attribution license="cc4" from="Microsoft" modified="false" />Any directives to add to the beginning of the code for the template. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -128,4 +180,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlPersister.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlPersister.xml index 463be2d59ff..a29f8690c8f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlPersister.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ControlPersister.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ControlPersister" FullName="System.Web.UI.Design.ControlPersister"> <TypeSignature Language="C#" Value="public sealed class ControlPersister" /> <AssemblyInfo> @@ -10,8 +11,18 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ControlPersister" /> class provides methods that can persist a <see cref="T:System.Web.UI.Control" /> control or an <see cref="T:System.Web.UI.ITemplate" /> interface implementation as a string of aspx code. The implementation of these methods is driven by metadata attributes, such as the <see cref="T:System.ComponentModel.DefaultValueAttribute" />, <see cref="T:System.Web.UI.PersistenceModeAttribute" />, and <see cref="T:System.ComponentModel.DesignerSerializationVisibilityAttribute" />.</para> + <block subset="none" type="note"> + <para>The Web Forms page designer does not support the Reset<paramref name="PropertyName" /> method that is optionally exposed by Microsoft Windows Forms-based controls for property persistence. </para> + </block> + <para>To create a <see cref="T:System.Web.UI.Control" /> object or an <see cref="T:System.Web.UI.ITemplate" /> interface by parsing a string of control- or template-persistence data, use the <see cref="T:System.Web.UI.Design.ControlParser" /> class methods.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides methods for persisting Web server controls at design-time.</para> + </summary> </Docs> <Members> <Member MemberName="PersistControl"> @@ -24,10 +35,17 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method requires an <see cref="T:System.ComponentModel.Design.IDesignerHost" /> implementation to work correctly. This method uses the <see cref="P:System.Web.UI.Control.Site" /> of the specified control to retrieve the designer host.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a string of data that represents the persisted form of the specified control.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> to persist. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -45,10 +63,18 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="sw">To be added.</param> - <param name="control">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method requires an <see cref="T:System.ComponentModel.Design.IDesignerHost" /> implementation to work correctly. This method uses the <see cref="P:System.Web.UI.Control.Site" /> of the specified control to retrieve the designer host.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Outputs a string of data that represents the persisted form of the specified control to the specified <see cref="T:System.IO.TextWriter" />.</para> + </summary> + <param name="sw"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.TextWriter" /> to output the persisted control data to. </param> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> to persist. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -66,11 +92,19 @@ <Parameter Name="host" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <param name="host">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method requires an <see cref="T:System.ComponentModel.Design.IDesignerHost" /> implementation to work correctly.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a string of data that represents the persisted form of the specified control, using the specified designer host.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> to persist. </param> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> that is the designer host for the control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -89,11 +123,20 @@ <Parameter Name="host" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="sw">To be added.</param> - <param name="control">To be added.</param> - <param name="host">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method requires an <see cref="T:System.ComponentModel.Design.IDesignerHost" /> implementation to work correctly.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Outputs a string of data that represents the persisted form of the specified control to the specified <see cref="T:System.IO.TextWriter" />, using the specified designer host.</para> + </summary> + <param name="sw"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.TextWriter" /> to output the persisted control data to. </param> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> to persist. </param> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> that is the designer host for the control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -111,11 +154,19 @@ <Parameter Name="host" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="host">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method requires an <see cref="T:System.ComponentModel.Design.IDesignerHost" /> implementation to work correctly.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a string of data that can persist the inner properties of the specified control.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to persist the inner properties of. </param> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> that is the designer host for the control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -134,11 +185,20 @@ <Parameter Name="host" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="sw">To be added.</param> - <param name="component">To be added.</param> - <param name="host">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method requires an <see cref="T:System.ComponentModel.Design.IDesignerHost" /> implementation to work correctly.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Outputs a string of data that can persist the inner properties of the specified control to the specified <see cref="T:System.IO.TextWriter" />, using the specified designer host.</para> + </summary> + <param name="sw"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.TextWriter" /> to use. </param> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to persist. </param> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> that is the designer host for the control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -159,11 +219,19 @@ <Parameter Name="host" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="template">To be added.</param> - <param name="host">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlPersister.PersistTemplate(System.Web.UI.ITemplate,System.ComponentModel.Design.IDesignerHost)" /> method requires an <see cref="T:System.ComponentModel.Design.IDesignerHost" /> interface implementation in order to work correctly.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a string of data that represents the persisted form of the specified template.</para> + </summary> + <param name="template"> + <attribution license="cc4" from="Microsoft" modified="false" />The template to persist.</param> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> that is the designer host for the control.</param> </Docs> </Member> <Member MemberName="PersistTemplate"> @@ -181,12 +249,21 @@ <Parameter Name="host" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="writer">To be added.</param> - <param name="template">To be added.</param> - <param name="host">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlPersister.PersistTemplate(System.IO.TextWriter,System.Web.UI.ITemplate,System.ComponentModel.Design.IDesignerHost)" /> method requires an <see cref="T:System.ComponentModel.Design.IDesignerHost" /> interface implementation in order to work correctly.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Writes a string of data that represents the persisted form of the specified template to the specified <see cref="T:System.IO.TextWriter" /> object.</para> + </summary> + <param name="writer"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.TextWriter" /> to write the persisted template data to.</param> + <param name="template"> + <attribution license="cc4" from="Microsoft" modified="false" />The template to persist.</param> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> that is the designer host for the control.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingCollectionConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingCollectionConverter.xml index cd072bc3dd6..5e13787071f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingCollectionConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingCollectionConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataBindingCollectionConverter" FullName="System.Web.UI.Design.DataBindingCollectionConverter"> <TypeSignature Language="C#" Value="public class DataBindingCollectionConverter : System.ComponentModel.TypeConverter" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This type converter calls the base <see cref="Overload:System.ComponentModel.TypeConverter.ConvertTo" /> method for all destination types except <see cref="T:System.String" />, for which an empty string ("") is returned.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type converter for <see cref="T:System.Web.UI.DataBindingCollection" /> objects.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes an instance of the <see cref="T:System.Web.UI.Design.DataBindingCollectionConverter" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -40,13 +50,23 @@ <Parameter Name="destinationType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <param name="destinationType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method returns an empty string if the <paramref name="destinationType" /> parameter is of type <see cref="T:System.String" />. Otherwise this method calls the <see cref="M:System.ComponentModel.TypeConverter.ConvertTo(System.Object,System.Type)" /> method of the base <see cref="T:System.ComponentModel.TypeConverter" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts a data binding collection to the specified type.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that indicates the component or control to which the data binding collection belongs. </param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Globalization.CultureInfo" /> that can be used to provide additional culture information. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to convert. </param> + <param name="destinationType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type to convert to. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -59,4 +79,4 @@ <AttributeName>System.Obsolete("This class is not supposed to be in use anymore as DesignerActionList is supposed to be used for editing DataBinding")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingCollectionEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingCollectionEditor.xml index d8cd9d34911..0ca26fc908c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingCollectionEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingCollectionEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataBindingCollectionEditor" FullName="System.Web.UI.Design.DataBindingCollectionEditor"> <TypeSignature Language="C#" Value="public class DataBindingCollectionEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.DataBindingCollectionEditor" /> class is obsolete. At design time, editing of data bindings is accomplished from a <see cref="T:System.ComponentModel.Design.DesignerActionList" /> instead of the property grid. For more information, see <see cref="P:System.Web.UI.Design.ControlDesigner.ActionLists" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for editing a collection of data bindings.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataBindingCollectionEditor" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,12 +49,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the specified data-binding collection using the specified service provider and context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that identifies the component or control the collection belongs to. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IServiceProvider" /> to use. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The collection to edit. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,10 +77,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This editor provides a modal editor style.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editor style used by the <see cref="M:System.Web.UI.Design.DataBindingCollectionEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that identifies the component or control to retrieve the edit style for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -77,4 +100,4 @@ <AttributeName>System.Obsolete("This class is not supposed to be in use anymore as DesignerActionList is supposed to be used for editing DataBinding")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingHandler.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingHandler.xml index cc56f959dd7..ec79e9b21a8 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataBindingHandler" FullName="System.Web.UI.Design.DataBindingHandler"> <TypeSignature Language="C#" Value="public abstract class DataBindingHandler" /> <AssemblyInfo> @@ -10,8 +11,18 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.DataBindingHandler" /> provides a base class for data-binding handlers. A data-binding handler can be used within a designer to perform data-binding to enable a meaningful display of the control on the design surface. Typically a control's designer is responsible for this functionality. However, when a control is not live on the design surface, such as within the template of another control, it does not have a designer, and this functionality is provided by a data-binding handler if one has been specified with a <see cref="T:System.Web.UI.DataBindingHandlerAttribute" /> in the code for the control.</para> + <para>To use a data-binding handler, the control which has the data-bound property or properties must have a <see cref="T:System.Web.UI.DataBindingHandlerAttribute" /> specified within its code that indicates the type of data-binding handler to use.</para> + <para>For example, the <see cref="T:System.Web.UI.WebControls.Label" /> control is associated with the <see cref="T:System.Web.UI.Design.TextDataBindingHandler" /> class through a <see cref="T:System.Web.UI.DataBindingHandlerAttribute" /> in the code for the <see cref="T:System.Web.UI.WebControls.Label" /> class. Within a template for a <see cref="T:System.Web.UI.WebControls.DataList" />, a <see cref="T:System.Web.UI.WebControls.Label" /> control whose text property has been data bound displays the word "DataBound" on the label. Without the data-binding handler, the label would be invisible at design-time, as it does not have a designer to bind its data-bound properties while in a templated control at design-time.</para> + <para>To implement a data-binding handler, define a new class that derives from this class and implement the <see cref="M:System.Web.UI.Design.DataBindingHandler.DataBindControl(System.ComponentModel.Design.IDesignerHost,System.Web.UI.Control)" /> method to set the appropriate properties.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base class for a data-binding handler.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +30,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataBindingHandler" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,10 +52,18 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <param name="control">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method should be implemented in a derived class to provide functionality to a custom data-binding handler. The logic for the data binding should be implemented within this method, and can be specific to the type or types that the data-binding handler is to bind a property or properties on.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Binds the specified control.</para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.IDesignerHost" /> for the document. </param> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> to bind. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -49,4 +71,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingValueUIHandler.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingValueUIHandler.xml index b1efcb4b150..04318f19e97 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingValueUIHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataBindingValueUIHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataBindingValueUIHandler" FullName="System.Web.UI.Design.DataBindingValueUIHandler"> <TypeSignature Language="C#" Value="public class DataBindingValueUIHandler" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a UI handler for data binding values.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataBindingValueUIHandler" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,11 +46,17 @@ <Parameter Name="valueUIItemList" Type="System.Collections.ArrayList" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="propDesc">To be added.</param> - <param name="valueUIItemList">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a data binding for the specified property and the specified value item list, if the current control has data bindings and the current object does not already have a binding.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can provide additional context information. </param> + <param name="propDesc"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.PropertyDescriptor" /> that represents the property to add a data binding for. </param> + <param name="valueUIItemList"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ArrayList" /> of items that have data bindings. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -51,4 +64,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataColumnSelectionConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataColumnSelectionConverter.xml index 1ea13471a7a..d170e7828f6 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataColumnSelectionConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataColumnSelectionConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataColumnSelectionConverter" FullName="System.Web.UI.Design.DataColumnSelectionConverter"> <TypeSignature Language="C#" Value="public class DataColumnSelectionConverter : System.ComponentModel.TypeConverter" /> <AssemblyInfo> @@ -9,8 +10,20 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="T:System.Web.UI.Design.DataColumnSelectionConverter" /> class to convert object types before assignment to a control property. In general, the <see cref="T:System.Web.UI.Design.DataColumnSelectionConverter" /> class supports converting string object types and supplies a list of standard values available for assignment to the associated control property. The standard values collection is the list of field names for bound column fields for the current <see cref="T:System.Web.UI.WebControls.GridView" /> control.</para> + <para>To support converting additional object types, derive a class from <see cref="T:System.Web.UI.Design.DataColumnSelectionConverter" /> and override the <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> and <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" /> methods for the additional object types. To support a custom list of standard assignable values, override the <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method.</para> + <para>Apply the <see cref="T:System.ComponentModel.TypeConverterAttribute" /> attribute to specify the <see cref="T:System.Web.UI.Design.DataColumnSelectionConverter" /> class as the type converter for a control property. For example, the <see cref="P:System.Web.UI.WebControls.GridView.RowHeaderColumn" /> property of the <see cref="T:System.Web.UI.WebControls.GridView" /> control specifies <see cref="T:System.Web.UI.Design.DataColumnSelectionConverter" /> as its type converter.</para> + <block subset="none" type="note"> + <para>You should never access a type converter directly. Instead, call the appropriate converter by using a <see cref="T:System.ComponentModel.TypeDescriptor" /> object. For more information, see the examples in <see cref="T:System.ComponentModel.TypeConverter" />.</para> + </block> + <para>The <see cref="Overload:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValuesSupported" /> method indicates that the converter supports returning a list of available values through the <see cref="Overload:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValues" /> method. The <see cref="Overload:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValuesExclusive" /> method indicates that the list is not an exclusive list of possible values.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type converter for a property representing the field name of a bound column field in a <see cref="T:System.Web.UI.WebControls.GridView" /> control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +34,16 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>You should never access a type converter directly. Instead, call the appropriate converter by using a <see cref="T:System.ComponentModel.TypeDescriptor" /> object. For more information, see the examples in <see cref="T:System.ComponentModel.TypeConverter" />.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataColumnSelectionConverter" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="CanConvertFrom"> @@ -39,11 +60,20 @@ <Parameter Name="sourceType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="sourceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call the <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> method to determine whether the <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" /> method supports converting the source type.</para> + <para>The <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" /> method can convert only from a string, so the <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> method returns true when <paramref name="sourceType" /> is a string.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the specified source type can be converted to the type of the associated control property.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> + <param name="sourceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type to convert from.</param> </Docs> </Member> <Member MemberName="ConvertFrom"> @@ -61,12 +91,22 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If <paramref name="value" /> is a string, then the string representation of <paramref name="value" /> is returned. If <paramref name="value" /> is null, an empty string ("") is returned. For all other values, a <see cref="T:System.NotSupportedException" /> exception is thrown. </para> + <para>Call the <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> method to determine whether the <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" /> method supports converting the source type.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the specified object to the type of the associated control property.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Globalization.CultureInfo" /> object that can be used to support localization features.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to convert.</param> </Docs> </Member> <Member MemberName="GetStandardValues"> @@ -82,10 +122,18 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method uses the <see cref="P:System.ComponentModel.ITypeDescriptorContext.Instance" /> property of the specified <paramref name="context" /> object to obtain an <see cref="T:System.ComponentModel.IComponent" /> implementation. If the <see cref="T:System.ComponentModel.IComponent" /> implementation is available, it is used to access the associated control at design time and retrieve the list of available values from the associated <see cref="T:System.Web.UI.WebControls.GridView" /> component.</para> + <para>The collection of available values is built from the bound column fields in the <see cref="T:System.Web.UI.WebControls.GridView" /> control. The bound column fields consist of <see cref="T:System.Web.UI.WebControls.BoundField" /> objects in the <see cref="P:System.Web.UI.WebControls.GridView.Columns" /> collection, and from the bound column fields automatically generated for fields in the data source.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a list of available values that can be assigned to the associated control property.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> </Docs> </Member> <Member MemberName="GetStandardValuesExclusive"> @@ -101,10 +149,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValuesExclusive" /> method for a <see cref="T:System.Web.UI.Design.DataColumnSelectionConverter" /> instance returns false, indicating that the list returned by the <see cref="Overload:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValues" /> method is not an exclusive list of all possible assignable values.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether this converter returns a list containing all possible values that can be assigned to the associated control property.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> </Docs> </Member> <Member MemberName="GetStandardValuesSupported"> @@ -120,11 +175,19 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)" /> method indicates whether the converter supports returning a list of available values through the <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method. </para> + <para>The <see cref="Overload:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValuesSupported" /> method for the <see cref="T:System.Web.UI.Design.DataColumnSelectionConverter" /> object returns true if the specified <paramref name="context" /> object supplies an <see cref="T:System.ComponentModel.IComponent" /> implementation in its <see cref="P:System.ComponentModel.ITypeDescriptorContext.Instance" /> property. The <see cref="M:System.Web.UI.Design.DataColumnSelectionConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method uses the <see cref="T:System.ComponentModel.IComponent" /> implementation to access the associated control at design time and retrieve the list of available bound column fields from the associated <see cref="T:System.Web.UI.WebControls.GridView" /> component.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether this converter returns a set of available values for assignment to a control property, within the specified context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataFieldConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataFieldConverter.xml index 9426d8c7b9a..52a6270bfce 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataFieldConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataFieldConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataFieldConverter" FullName="System.Web.UI.Design.DataFieldConverter"> <TypeSignature Language="C#" Value="public class DataFieldConverter : System.ComponentModel.TypeConverter" /> <AssemblyInfo> @@ -10,8 +11,20 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.DataFieldConverter" /> can retrieve a list of data fields from the current data source of a design-time component.</para> + <para>This type converter is used by vsprvslong to provide the values that appear in the list of data fields in the Properties window.</para> + <block subset="none" type="note"> + <para>You should never access a type converter directly. Instead, call the appropriate converter by using <see cref="T:System.ComponentModel.TypeDescriptor" />. For more information, see the examples in the <see cref="T:System.ComponentModel.TypeConverter" /> base class.</para> + </block> + <para>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">[<topic://cpconImplementingTypeConverter>]</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type converter that can retrieve a list of data fields from the current component's selected data source.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +32,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataFieldConverter" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,11 +54,19 @@ <Parameter Name="sourceType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="sourceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method returns true if the source type is a string. Otherwise, this method always returns false.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the converter can convert an object of the specified source type to the native type of the converter.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information. </param> + <param name="sourceType"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Type" /> that represents the type you wish to convert from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,12 +85,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the specified object to the native type of the converter.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information. </param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Globalization.CultureInfo" /> that can be used to support localization features. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> to convert. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -83,10 +113,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method uses the <see cref="T:System.Web.UI.Design.IDataSourceProvider" /> implementation on the component's designer to retrieve the selected data source.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data fields present within the selected data source if information about them is available.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object indicating the component or control to get values for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -103,10 +140,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then there are other valid values besides the list of standard values that <see cref="M:System.ComponentModel.TypeConverter.GetStandardValues" /> provides.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the collection of standard values returned from <see cref="M:System.ComponentModel.TypeConverter.GetStandardValues" /> is a list of all possible values.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -123,10 +167,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the converter supports a standard set of values that can be picked from a list.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -134,4 +182,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataMemberConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataMemberConverter.xml index f75755e726a..44f1afa06e2 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataMemberConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataMemberConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataMemberConverter" FullName="System.Web.UI.Design.DataMemberConverter"> <TypeSignature Language="C#" Value="public class DataMemberConverter : System.ComponentModel.TypeConverter" /> <AssemblyInfo> @@ -10,8 +11,20 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.DataMemberConverter" /> provides methods that can retrieve a list of data members from the current data source of a design-time component.</para> + <para>This type converter is used by vsprvslong to provide the values that appear in the list of data members in the Properties window.</para> + <block subset="none" type="note"> + <para>You should never access a type converter directly. Instead, call the appropriate converter by using <see cref="T:System.ComponentModel.TypeDescriptor" />. For more information, see the examples in the <see cref="T:System.ComponentModel.TypeConverter" /> base class.</para> + </block> + <para>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">[<topic://cpconImplementingTypeConverter>]</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type converter that can retrieve a list of data members from the current component's selected data source.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +32,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataFieldConverter" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,11 +54,16 @@ <Parameter Name="sourceType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="sourceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the converter can convert an object of the specified source type to the native type of the converter.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information. </param> + <param name="sourceType"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Type" /> that represents the type you wish to convert from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,12 +82,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the specified object to the native type of the converter.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information. </param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Globalization.CultureInfo" /> that can be used to support localization features. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> to convert. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -83,10 +110,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The converter uses the <see cref="T:System.Web.UI.Design.IDataSourceProvider" /> implementation of the associated component's designer to retrieve the current data source selection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data members present within the selected data source, if information about them is available.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object indicating the component or control to get values for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -103,10 +137,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then there are other valid values besides the list of standard values that <see cref="M:System.ComponentModel.TypeConverter.GetStandardValues" /> provides.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the collection of standard values returned from <see cref="M:System.ComponentModel.TypeConverter.GetStandardValues" /> is a list of all possible values.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that provides a format context. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -123,10 +164,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the converter supports a standard set of values that can be picked from a list.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -134,4 +179,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetFieldSchema.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetFieldSchema.xml index 9e35834d8f8..74020c90be6 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetFieldSchema.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetFieldSchema.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSetFieldSchema" FullName="System.Web.UI.Design.DataSetFieldSchema"> <TypeSignature Language="C#" Value="public sealed class DataSetFieldSchema : System.Web.UI.Design.IDataSourceFieldSchema" /> <AssemblyInfo> @@ -13,8 +14,33 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class to get the properties of a data field using a <see cref="T:System.Data.DataColumn" />. You can discover the structure of a data field by using the following properties in this class: <see cref="P:System.Web.UI.Design.DataSetFieldSchema.DataType" />, <see cref="P:System.Web.UI.Design.DataSetFieldSchema.IsReadOnly" />, <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Length" />, <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Name" />, and <see cref="P:System.Web.UI.Design.DataSetFieldSchema.IsUnique" />. In addition, you can use the <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Identity" /> property to determine if a data column is set for <see cref="P:System.Data.DataColumn.AutoIncrement" />, or the <see cref="P:System.Web.UI.Design.DataSetFieldSchema.PrimaryKey" /> property to determine if a data column is in the primary key.</para> + <para>The <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class is used by custom control designer components to provide information about a data field at design time. </para> + <para>To examine the components of data using a <see cref="T:System.Data.DataSet" />, use the following classes.</para> + <list type="bullet"> + <item> + <para> + <see cref="T:System.Web.UI.Design.DataSetSchema" /> + </para> + </item> + <item> + <para> + <see cref="T:System.Web.UI.Design.DataSetViewSchema" /> + </para> + </item> + <item> + <para> + <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> + </para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the structure, or schema, of a data field.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,9 +53,16 @@ <Parameter Name="column" Type="System.Data.DataColumn" /> </Parameters> <Docs> - <param name="column">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class to examine the properties of a data field using a <see cref="T:System.Data.DataColumn" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class using a specified <see cref="T:System.Data.DataColumn" />.</para> + </summary> + <param name="column"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.DataColumn" /> object that the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> object describes.</param> </Docs> </Member> <Member MemberName="DataType"> @@ -42,9 +75,12 @@ <ReturnType>System.Type</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type of data stored in the data field.</para> + </summary> </Docs> </Member> <Member MemberName="Identity"> @@ -57,9 +93,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Identity" /> property corresponds to the <see cref="P:System.Data.DataColumn.AutoIncrement" /> property of a <see cref="T:System.Data.DataColumn" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the value of the data field automatically increments for each new row added to the table or view.</para> + </summary> </Docs> </Member> <Member MemberName="IsReadOnly"> @@ -72,9 +114,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Data.DataColumn" /> is read-only.</para> + </summary> </Docs> </Member> <Member MemberName="IsUnique"> @@ -87,9 +132,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.IsUnique" /> property corresponds to the <see cref="P:System.Data.DataColumn.Unique" /> property of a <see cref="T:System.Data.DataColumn" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether values in the data field are required to be unique.</para> + </summary> </Docs> </Member> <Member MemberName="Length"> @@ -102,9 +153,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Length" /> property corresponds to the <see cref="P:System.Data.DataColumn.MaxLength" /> property of a <see cref="T:System.Data.DataColumn" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating the size of data that can be stored in the data field.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -117,9 +174,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Name" /> property corresponds to the <see cref="P:System.Data.DataColumn.ColumnName" /> property of a <see cref="T:System.Data.DataColumn" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the data field.</para> + </summary> </Docs> </Member> <Member MemberName="Nullable"> @@ -132,9 +195,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Nullable" /> property corresponds to the <see cref="P:System.Data.DataColumn.AllowDBNull" /> property of a <see cref="T:System.Data.DataColumn" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the data field can accept null values.</para> + </summary> </Docs> </Member> <Member MemberName="Precision"> @@ -147,9 +216,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Precision" /> property is required by the <see cref="T:System.Web.UI.Design.IDataSourceFieldSchema" /> interface, but is not used by the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the maximum number of digits used to represent a numerical value in the data field.</para> + </summary> </Docs> </Member> <Member MemberName="PrimaryKey"> @@ -162,9 +237,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the data field is in the primary key for the containing table or view.</para> + </summary> </Docs> </Member> <Member MemberName="Scale"> @@ -177,10 +255,16 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Scale" /> property is required by the <see cref="T:System.Web.UI.Design.IDataSourceFieldSchema" /> interface, but is not used by the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of decimal places to which numerical values in the data field are resolved.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetSchema.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetSchema.xml index 3be4ec72c6c..c3c2136c7a8 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetSchema.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetSchema.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSetSchema" FullName="System.Web.UI.Design.DataSetSchema"> <TypeSignature Language="C#" Value="public sealed class DataSetSchema : System.Web.UI.Design.IDataSourceSchema" /> <AssemblyInfo> @@ -13,8 +14,33 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="T:System.Web.UI.Design.DataSetSchema" /> class to list the elements of a data source at design time. This implementation of <see cref="T:System.Web.UI.Design.IDataSourceSchema" /> uses a <see cref="T:System.Data.DataSet" /> to list the views and fields.</para> + <para>The <see cref="T:System.Web.UI.Design.DataSetSchema" /> class is used by custom control designer components to provide lists of views and fields for data-bound controls at design time.</para> + <para>To examine the components of data using a <see cref="T:System.Data.DataSet" />, use the following classes:</para> + <list type="bullet"> + <item> + <para> + <see cref="T:System.Web.UI.Design.DataSetSchema" /> + </para> + </item> + <item> + <para> + <see cref="T:System.Web.UI.Design.DataSetViewSchema" /> + </para> + </item> + <item> + <para> + <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> + </para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.DataSetSchema" /> class represents the structure, or schema, of a data source. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,9 +53,13 @@ <Parameter Name="dataSet" Type="System.Data.DataSet" /> </Parameters> <Docs> - <param name="dataSet">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of the <see cref="T:System.Web.UI.Design.DataSetSchema" /> class using a specified <see cref="T:System.Data.DataSet" />.</para> + </summary> + <param name="dataSet"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataSet" /> that the <see cref="T:System.Web.UI.Design.DataSetSchema" /> instance will describe.</param> </Docs> </Member> <Member MemberName="GetViews"> @@ -43,10 +73,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Each of the <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" /> objects returned by this method can be converted to a <see cref="T:System.Web.UI.Design.DataSetViewSchema" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array containing information about each view in the data source.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetViewSchema.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetViewSchema.xml index d8ee45aa841..d707bb6404c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetViewSchema.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSetViewSchema.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSetViewSchema" FullName="System.Web.UI.Design.DataSetViewSchema"> <TypeSignature Language="C#" Value="public sealed class DataSetViewSchema : System.Web.UI.Design.IDataSourceViewSchema" /> <AssemblyInfo> @@ -13,8 +14,33 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="T:System.Web.UI.Design.DataSetViewSchema" /> class to list the structure of data using a <see cref="T:System.Data.DataTable" /> at design time. Use the <see cref="M:System.Web.UI.Design.DataSetViewSchema.GetFields" /> method to get a list of information about each field as <see cref="T:System.Data.DataColumn" /> objects.</para> + <para>The <see cref="T:System.Web.UI.Design.DataSetViewSchema" /> class is used by custom control designer components to provide UI options to the user at design time that accurately reflect the structure of the data.</para> + <para>To examine the components of data using a <see cref="T:System.Data.DataSet" />, use the following classes.</para> + <list type="bullet"> + <item> + <para> + <see cref="T:System.Web.UI.Design.DataSetSchema" /> + </para> + </item> + <item> + <para> + <see cref="T:System.Web.UI.Design.DataSetViewSchema" /> + </para> + </item> + <item> + <para> + <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> + </para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the structure, or schema, of a <see cref="T:System.Data.DataTable" />. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,9 +53,13 @@ <Parameter Name="dataTable" Type="System.Data.DataTable" /> </Parameters> <Docs> - <param name="dataTable">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of the <see cref="T:System.Web.UI.Design.DataSetViewSchema" /> class using a specified <see cref="T:System.Data.DataTable" />.</para> + </summary> + <param name="dataTable"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataTable" /> that the <see cref="T:System.Web.UI.Design.DataSetViewSchema" /> instance will describe.</param> </Docs> </Member> <Member MemberName="GetChildren"> @@ -43,9 +73,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSetViewSchema.GetChildren" /> method inherited from <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" /> is not implemented in this class and always returns null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array representing the child views contained in the current view.</para> + </summary> </Docs> </Member> <Member MemberName="GetFields"> @@ -59,9 +95,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSetViewSchema.GetFields" /> method does not return information about hidden fields.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array containing information about each data field in the view.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -74,10 +116,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the view using its <see cref="P:System.Data.DataTable.TableName" /> property.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceBooleanViewSchemaConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceBooleanViewSchemaConverter.xml index d72041551b5..24a1301b6c9 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceBooleanViewSchemaConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceBooleanViewSchemaConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSourceBooleanViewSchemaConverter" FullName="System.Web.UI.Design.DataSourceBooleanViewSchemaConverter"> <TypeSignature Language="C#" Value="public class DataSourceBooleanViewSchemaConverter : System.Web.UI.Design.DataSourceViewSchemaConverter" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type converter for a property representing a Boolean field in a data source schema.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new instance of the <see cref="T:System.Web.UI.Design.DataSourceBooleanViewSchemaConverter" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="GetStandardValues"> @@ -38,11 +45,15 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a list of available Boolean values that can be assigned to the associated field.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceConverter.xml index bda1fe82fa6..5cd57eaf8b0 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSourceConverter" FullName="System.Web.UI.Design.DataSourceConverter"> <TypeSignature Language="C#" Value="public class DataSourceConverter : System.ComponentModel.TypeConverter" /> <AssemblyInfo> @@ -10,8 +11,20 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.DataSourceConverter" /> provides methods that can be used to retrieve a list of data sources accessible to the current design-time component.</para> + <para>This type converter is used by vsprvslong to provide the values that appear in the list of data sources in the <ui>Properties</ui> window.</para> + <block subset="none" type="note"> + <para>You should never access a type converter directly. Instead, call the appropriate converter by using <see cref="T:System.ComponentModel.TypeDescriptor" />. For more information, see the examples in the <see cref="T:System.ComponentModel.TypeConverter" /> base class.</para> + </block> + <para>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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type converter that can retrieve a list of data sources accessible to the current component.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +32,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataSourceConverter" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,11 +54,16 @@ <Parameter Name="sourceType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="sourceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the converter can convert an object of the specified source type to the native type of the converter.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="sourceType"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Type" /> that represents the type you want to convert from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,12 +82,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the specified object to the native type of the converter.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Globalization.CultureInfo" /> that can be used to support localization features. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> to convert. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -83,10 +110,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The data sources that are accessible to the component are determined by retrieving a list of components from the designer, testing each component with the <see cref="M:System.Web.UI.Design.DataSourceConverter.IsValidDataSource(System.ComponentModel.IComponent)" /> method, and then returning the components that are valid data sources.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the standard data sources accessible to the control.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> indicating the component or control to get values for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -103,10 +137,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then there are other valid values besides the list of standard values that <see cref="M:System.ComponentModel.TypeConverter.GetStandardValues" /> provides.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the collection of standard values returned from <see cref="M:System.ComponentModel.TypeConverter.GetStandardValues" /> is a list of all possible values.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -123,10 +164,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the converter supports a standard set of values that can be picked from a list.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -146,11 +191,18 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method uses the <see cref="M:System.Web.UI.Design.DataSourceConverter.IsValidDataSource(System.ComponentModel.IComponent)" /> method to determine the components that are available as standard accessible data sources. For the <see cref="T:System.Web.UI.Design.DataSourceConverter" /> class, a valid data source is a component that implements the <see cref="T:System.Collections.IEnumerable" /> or <see cref="T:System.ComponentModel.IListSource" /> interface. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the specified component is a valid data source for this converter.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to check as a valid data source.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceDesigner.xml index 0c20deb6069..5a1132573f3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSourceDesigner" FullName="System.Web.UI.Design.DataSourceDesigner"> <TypeSignature Language="C#" Value="public class DataSourceDesigner : System.Web.UI.Design.ControlDesigner, System.Web.UI.Design.IDataSourceDesigner" /> <AssemblyInfo> @@ -13,8 +14,24 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class is the base class for data source designers, such as the <see cref="T:System.Web.UI.Design.WebControls.SqlDataSourceDesigner" />, <see cref="T:System.Web.UI.Design.WebControls.AccessDataSourceDesigner" />, and <see cref="T:System.Web.UI.Design.WebControls.ObjectDataSourceDesigner" /> classes. If you create a new data source control, you might also want to create a custom control designer for your control and derive it from the <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class.</para> + <para>The <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class has two event methods: the <see cref="M:System.Web.UI.Design.DataSourceDesigner.OnDataSourceChanged(System.EventArgs)" /> and <see cref="M:System.Web.UI.Design.DataSourceDesigner.OnSchemaRefreshed(System.EventArgs)" /> methods. Both of these events can be temporarily disabled with the <see cref="M:System.Web.UI.Design.DataSourceDesigner.SuppressDataSourceEvents" /> method, which sets the <see cref="P:System.Web.UI.Design.DataSourceDesigner.SuppressingDataSourceEvents" /> property. The event methods can be enabled again with the <see cref="M:System.Web.UI.Design.DataSourceDesigner.ResumeDataSourceEvents" /> method.</para> + <para>There are two static methods that you can use to evaluate the equivalency of schemas or views without creating an instance of the class:</para> + <list type="bullet"> + <item> + <para>The <see cref="M:System.Web.UI.Design.DataSourceDesigner.SchemasEquivalent(System.Web.UI.Design.IDataSourceSchema,System.Web.UI.Design.IDataSourceSchema)" /> method compares two schemas.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DataSourceDesigner.ViewSchemasEquivalent(System.Web.UI.Design.IDataSourceViewSchema,System.Web.UI.Design.IDataSourceViewSchema)" /> method compares the schemas of two views.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a design host for the <see cref="T:System.Web.UI.DataSourceControl" /> class.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,8 +42,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceDesigner.#ctor" /> constructor is called by the design host at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="ActionLists"> @@ -39,9 +62,12 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a list of items that are used to create an action list menu at design time.</para> + </summary> </Docs> </Member> <Member MemberName="CanConfigure"> @@ -54,9 +80,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="P:System.Web.UI.Design.DataSourceDesigner.CanConfigure" /> property in a custom class to enable or disable design-time configuration for a specific data source.</para> + <para>A design host such as vsprvslong uses the <see cref="P:System.Web.UI.Design.DataSourceDesigner.CanConfigure" /> property to determine whether a command to configure the data source appears in the action list menu at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="M:System.Web.UI.Design.DataSourceDesigner.Configure" /> method can be called.</para> + </summary> </Docs> </Member> <Member MemberName="CanRefreshSchema"> @@ -69,9 +102,31 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="P:System.Web.UI.Design.DataSourceDesigner.CanRefreshSchema" /> property in a derived class to enable or disable the ability to refresh the schema at design time for a specific data source. If your application requires an invariant data structure and the schema will never change, you want the <see cref="P:System.Web.UI.Design.DataSourceDesigner.CanRefreshSchema" /> property to return false.</para> + <para>A design host such as vsprvslong uses the <see cref="P:System.Web.UI.Design.DataSourceDesigner.CanRefreshSchema" /> property to determine whether a command to refresh the schema appears in the action list menu at design time.</para> + <para>In a design host such as vsprvslong, you can see the <see cref="P:System.Web.UI.Design.DataSourceDesigner.CanRefreshSchema" /> property in action by completing the following process:</para> + <list type="ordered"> + <item> + <para>On your page, place a <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> or an <see cref="T:System.Web.UI.WebControls.AccessDataSource" /> control.</para> + </item> + <item> + <para>In Design view, on the action list, click <ui>Configure</ui>.</para> + </item> + <item> + <para>Remove a few fields from the data source. </para> + </item> + <item> + <para>On the action list, click <ui>Refresh Schema</ui>.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="M:System.Web.UI.Design.DataSourceDesigner.RefreshSchema(System.Boolean)" /> method can be called.</para> + </summary> </Docs> </Member> <Member MemberName="Configure"> @@ -85,8 +140,23 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceDesigner.Configure" /> method is not supported in the <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class; however, it can be overridden by custom data source designers inheriting from the <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class.</para> + <para>In a design host such as vsprvslong, you can see the <see cref="M:System.Web.UI.Design.DataSourceDesigner.Configure" /> method in action by completing the following process:</para> + <list type="ordered"> + <item> + <para>Put a <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> or an <see cref="T:System.Web.UI.WebControls.AccessDataSource" /> control on your page.</para> + </item> + <item> + <para>In Design view, on the action list, clicking <ui>Configure</ui>.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Launches the data source configuration utility in the design host.</para> + </summary> </Docs> </Member> <Member MemberName="DataSourceChanged"> @@ -99,8 +169,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when any property of the associated data source changes.</para> + </summary> </Docs> </Member> <Member MemberName="GetDesignTimeHtml"> @@ -114,9 +187,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation of the <see cref="M:System.Web.UI.Design.DataSourceDesigner.GetDesignTimeHtml" /> method returns the result from the base <see cref="M:System.Web.UI.Design.ControlDesigner.CreatePlaceHolderDesignTimeHtml" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup for displaying the associated data source control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="GetView"> @@ -132,10 +211,17 @@ <Parameter Name="viewName" Type="System.String" /> </Parameters> <Docs> - <param name="viewName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>In derived classes, if <paramref name="viewName" /> does not exist, the <see cref="M:System.Web.UI.Design.DataSourceDesigner.GetView(System.String)" /> method should return null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves a <see cref="T:System.Web.UI.Design.DesignerDataSourceView" /> object that is identified by the view name.</para> + </summary> + <param name="viewName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the view.</param> </Docs> </Member> <Member MemberName="GetViewNames"> @@ -149,9 +235,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an array of the view names that are available in this data source.</para> + </summary> </Docs> </Member> <Member MemberName="OnDataSourceChanged"> @@ -167,9 +256,16 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceDesigner.OnDataSourceChanged(System.EventArgs)" /> method notifies the control designers of each control that is bound to the associated data source to refresh its control in the design host. The <see cref="M:System.Web.UI.Design.DataSourceDesigner.OnDataSourceChanged(System.EventArgs)" /> method can be suppressed with the <see cref="M:System.Web.UI.Design.DataSourceDesigner.SuppressDataSourceEvents" /> method or by calling the <see cref="M:System.Web.UI.Design.DataSourceDesigner.RefreshSchema(System.Boolean)" /> method with an argument of false.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.Web.UI.Design.DataSourceDesigner.DataSourceChanged" /> event when the properties of the data source have changed and the <see cref="P:System.Web.UI.Design.DataSourceDesigner.SuppressingDataSourceEvents" /> value is false.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object provided by the calling object.</param> </Docs> </Member> <Member MemberName="OnSchemaRefreshed"> @@ -185,9 +281,16 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceDesigner.OnSchemaRefreshed(System.EventArgs)" /> method notifies the control designers of each control that is bound to the associated data source that the fields in the schema have changed. The <see cref="M:System.Web.UI.Design.DataSourceDesigner.OnSchemaRefreshed(System.EventArgs)" /> method can be suppressed with the <see cref="M:System.Web.UI.Design.DataSourceDesigner.SuppressDataSourceEvents" /> method or by calling the <see cref="M:System.Web.UI.Design.DataSourceDesigner.RefreshSchema(System.Boolean)" /> property with an argument of false.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.Web.UI.Design.DataSourceDesigner.SchemaRefreshed" /> event when the schema of the data source has changed and the <see cref="P:System.Web.UI.Design.DataSourceDesigner.SuppressingDataSourceEvents" /> value is false.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object.</param> </Docs> </Member> <Member MemberName="RefreshSchema"> @@ -203,9 +306,16 @@ <Parameter Name="preferSilent" Type="System.Boolean" /> </Parameters> <Docs> - <param name="preferSilent">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceDesigner.RefreshSchema(System.Boolean)" /> method is not supported in the <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class. However, it is supported in derived classes, such as the <see cref="T:System.Web.UI.Design.WebControls.XmlDataSourceDesigner" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Refreshes the schema from the data source, while optionally suppressing events.</para> + </summary> + <param name="preferSilent"> + <attribution license="cc4" from="Microsoft" modified="false" />true to allow events when refreshing the schema; false to disable the <see cref="E:System.Web.UI.Design.DataSourceDesigner.DataSourceChanged" /> and <see cref="E:System.Web.UI.Design.DataSourceDesigner.SchemaRefreshed" /> events when refreshing the schema.</param> </Docs> </Member> <Member MemberName="ResumeDataSourceEvents"> @@ -219,8 +329,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Data source events can be suppressed by setting the <see cref="P:System.Web.UI.Design.DataSourceDesigner.SuppressingDataSourceEvents" /> property to false or by calling the <see cref="M:System.Web.UI.Design.DataSourceDesigner.RefreshSchema(System.Boolean)" /> method with an argument of true.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Restores data source events after the data source events have been suppressed.</para> + </summary> </Docs> </Member> <Member MemberName="SchemaRefreshed"> @@ -233,8 +349,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs after the schema has been refreshed.</para> + </summary> </Docs> </Member> <Member MemberName="SchemasEquivalent"> @@ -251,11 +370,19 @@ <Parameter Name="schema2" Type="System.Web.UI.Design.IDataSourceSchema" /> </Parameters> <Docs> - <param name="schema1">To be added.</param> - <param name="schema2">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Comparison of the two schemas is based on the views, as well as the names and types of the fields that are contained in the views. The <see cref="M:System.Web.UI.Design.DataSourceDesigner.SchemasEquivalent(System.Web.UI.Design.IDataSourceSchema,System.Web.UI.Design.IDataSourceSchema)" /> method can be used without an instance of the <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a value that indicates whether two schemas are equal.</para> + </summary> + <param name="schema1"> + <attribution license="cc4" from="Microsoft" modified="false" />The first schema to compare (derived from the <see cref="T:System.Web.UI.Design.IDataSourceSchema" />).</param> + <param name="schema2"> + <attribution license="cc4" from="Microsoft" modified="false" />The second schema to compare.</param> </Docs> </Member> <Member MemberName="SuppressDataSourceEvents"> @@ -269,8 +396,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Postpones all data source events until after the <see cref="M:System.Web.UI.Design.DataSourceDesigner.ResumeDataSourceEvents" /> method is called.</para> + </summary> </Docs> </Member> <Member MemberName="SuppressingDataSourceEvents"> @@ -283,9 +413,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DataSourceDesigner.SuppressingDataSourceEvents" /> property can be set by calling the <see cref="M:System.Web.UI.Design.DataSourceDesigner.SuppressDataSourceEvents" /> or <see cref="M:System.Web.UI.Design.DataSourceDesigner.RefreshSchema(System.Boolean)" /> method with an argument of true.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="E:System.Web.UI.Design.DataSourceDesigner.DataSourceChanged" /> event or the <see cref="M:System.Web.UI.Design.DataSourceDesigner.RefreshSchema(System.Boolean)" /> method occurs.</para> + </summary> </Docs> </Member> <Member MemberName="ViewSchemasEquivalent"> @@ -302,12 +438,20 @@ <Parameter Name="viewSchema2" Type="System.Web.UI.Design.IDataSourceViewSchema" /> </Parameters> <Docs> - <param name="viewSchema1">To be added.</param> - <param name="viewSchema2">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceDesigner.ViewSchemasEquivalent(System.Web.UI.Design.IDataSourceViewSchema,System.Web.UI.Design.IDataSourceViewSchema)" /> method can be used without an instance of the <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a value that determines whether two schema views are equal.</para> + </summary> + <param name="viewSchema1"> + <attribution license="cc4" from="Microsoft" modified="false" />The first view to compare (derived from the <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" />).</param> + <param name="viewSchema2"> + <attribution license="cc4" from="Microsoft" modified="false" />The second view to compare.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceViewSchemaConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceViewSchemaConverter.xml index 560c3dd8f57..2bbed2230e7 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceViewSchemaConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DataSourceViewSchemaConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DataSourceViewSchemaConverter" FullName="System.Web.UI.Design.DataSourceViewSchemaConverter"> <TypeSignature Language="C#" Value="public class DataSourceViewSchemaConverter : System.ComponentModel.TypeConverter" /> <AssemblyInfo> @@ -9,8 +10,20 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="T:System.Web.UI.Design.DataSourceViewSchemaConverter" /> class to convert object types before assignment to a control property. In general, the <see cref="T:System.Web.UI.Design.DataSourceViewSchemaConverter" /> supports converting string object types and supplies a list of standard values available for assignment to the associated control property. The standard values collection is the list of fields in the data source schema for the current control.</para> + <para>To support converting additional object types, derive a class from <see cref="T:System.Web.UI.Design.DataSourceViewSchemaConverter" /> and override the <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> and <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" /> methods for the additional object types. To support a custom list of standard assignable values, override the <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method.</para> + <para>Apply the <see cref="T:System.ComponentModel.TypeConverterAttribute" /> attribute to specify the <see cref="T:System.Web.UI.Design.DataSourceViewSchemaConverter" /> class as the type converter for a control property. For example, the <see cref="P:System.Web.UI.WebControls.DataControlField.SortExpression" /> property of the <see cref="T:System.Web.UI.WebControls.DataControlField" /> class and the <see cref="P:System.Web.UI.WebControls.BoundField.DataField" /> property of the <see cref="T:System.Web.UI.WebControls.BoundField" /> class use the <see cref="T:System.Web.UI.Design.DataSourceViewSchemaConverter" /> as the property type converter.</para> + <block subset="none" type="note"> + <para>You should never access a type converter directly. Instead, call the appropriate converter by using a <see cref="T:System.ComponentModel.TypeDescriptor" /> object. For more information, see the examples in <see cref="T:System.ComponentModel.TypeConverter" />.</para> + </block> + <para>The <see cref="Overload:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValuesSupported" /> method indicates that the converter supports returning a list of available values through the <see cref="Overload:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValues" /> method. The <see cref="Overload:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValuesExclusive" /> method indicates that the list is not an exclusive list of possible values.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type converter for a property representing a field in a data source schema.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +34,16 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>You should never access a type converter directly. Instead, call the appropriate converter by using a <see cref="T:System.ComponentModel.TypeDescriptor" /> object. For more information, see the examples in <see cref="T:System.ComponentModel.TypeConverter" />.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataSourceViewSchemaConverter" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="CanConvertFrom"> @@ -39,11 +60,20 @@ <Parameter Name="sourceType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="sourceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call the <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> method to determine whether the <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" /> method supports converting the source type.</para> + <para>The <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" /> method can convert only from a string, so the <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> method returns true when <paramref name="sourceType" /> is a string.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the specified source type can be converted to the type of the associated control property.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> + <param name="sourceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type to convert from.</param> </Docs> </Member> <Member MemberName="ConvertFrom"> @@ -61,12 +91,22 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If <paramref name="value" /> is a string, then the string representation of <paramref name="value" /> is returned. If <paramref name="value" /> is null, an empty string ("") is returned. For all other specified values, a <see cref="T:System.NotSupportedException" /> exception is thrown. </para> + <para>Call the <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> method to determine whether the <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" /> method supports converting the source type.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the specified object to the type of the associated control property.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Globalization.CultureInfo" /> object that can be used to support localization features.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to convert.</param> </Docs> </Member> <Member MemberName="GetStandardValues"> @@ -82,10 +122,18 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method uses the <see cref="P:System.ComponentModel.ITypeDescriptorContext.Instance" /> property of the specified <paramref name="context" /> object to obtain an <see cref="T:System.Web.UI.IDataSourceViewSchemaAccessor" /> implementation. If the <see cref="T:System.Web.UI.IDataSourceViewSchemaAccessor" /> implementation is available, it is used to access the data source schema for the associated control at design time and retrieve the list of available fields from the associated data source schema view.</para> + <para>The collection of available values is built from the fields in the data source schema for the associated control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a list of available values that can be assigned to the associated control property.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> </Docs> </Member> <Member MemberName="GetStandardValues"> @@ -102,11 +150,16 @@ <Parameter Name="typeFilter" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="typeFilter">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a list of available values that can be assigned to the associated control property.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> + <param name="typeFilter"> + <attribution license="cc4" from="Microsoft" modified="false" />A type used to filter fields to include in the standard values list.</param> </Docs> </Member> <Member MemberName="GetStandardValuesExclusive"> @@ -122,10 +175,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValuesExclusive" /> method for a <see cref="T:System.Web.UI.Design.DataSourceViewSchemaConverter" /> returns false, indicating that the list returned by the <see cref="Overload:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValues" /> method is not an exclusive list of all possible assignable values.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether this converter returns a list containing all possible values that can be assigned to the associated control property.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> </Docs> </Member> <Member MemberName="GetStandardValuesSupported"> @@ -141,11 +201,19 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)" /> method indicates whether the converter supports returning a list of available values through the <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method.</para> + <para>The <see cref="Overload:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValuesSupported" /> method for the <see cref="T:System.Web.UI.Design.DataSourceViewSchemaConverter" /> object returns true if the specified <paramref name="context" /> object supplies an <see cref="T:System.Web.UI.IDataSourceViewSchemaAccessor" /> implementation in its <see cref="P:System.ComponentModel.ITypeDescriptorContext.Instance" /> property. The <see cref="M:System.Web.UI.Design.DataSourceViewSchemaConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method uses the <see cref="T:System.Web.UI.IDataSourceViewSchemaAccessor" /> implementation to retrieve the list of available fields from the associated data source schema.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether this converter returns a set of available values for assignment to a control property within the specified context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> implementation that can be used to gain additional context information.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignTimeData.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignTimeData.xml index ca4540f900d..c881813d4f3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignTimeData.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignTimeData.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignTimeData" FullName="System.Web.UI.Design.DesignTimeData"> <TypeSignature Language="C#" Value="public sealed class DesignTimeData" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides helper methods that can be used by control designers to generate sample data for data-bound properties at design time. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName="CreateDummyDataBoundDataTable"> @@ -25,9 +29,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The table is not actually bound to a data source. Each column name simply indicates that it is a data-bound column. The column data types are string, integer, and string. The calling designer component must add rows and data to the resulting table.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a <see cref="T:System.Data.DataTable" /> object that contains three columns with names indicating that the columns are connected to a data source.</para> + </summary> </Docs> </Member> <Member MemberName="CreateDummyDataTable"> @@ -38,9 +48,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The column data types are all string. The calling designer component can call the <see cref="M:System.Web.UI.Design.DesignTimeData.GetDesignTimeDataSource(System.Data.DataTable,System.Int32)" /> method to add rows of data to the resulting table.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a <see cref="T:System.Data.DataTable" /> object that contains three columns with names that indicate that the columns contain sample data.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -57,10 +73,17 @@ <Parameter Name="referenceData" Type="System.Collections.IEnumerable" /> </Parameters> <Docs> - <param name="referenceData">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The data types that can be created are the primitive types, such as number, string, and date types. Any other types are replaced by columns of type String. The calling designer component can call the <see cref="M:System.Web.UI.Design.DesignTimeData.GetDesignTimeDataSource(System.Data.DataTable,System.Int32)" /> method to add rows of data to the resulting table.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a sample <see cref="T:System.Data.DataTable" /> object with the same schema as the provided data.</para> + </summary> + <param name="referenceData"> + <attribution license="cc4" from="Microsoft" modified="false" />A data source with the desired schema to use as the format for the sample <see cref="T:System.Data.DataTable" /> object. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -81,11 +104,19 @@ <Parameter Name="useDataBoundData" Type="System.Boolean" /> </Parameters> <Docs> - <param name="referenceData">To be added.</param> - <param name="useDataBoundData">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The data types that can be created are the primitive types, such as number, string, and date types. Any other types are replaced by columns of type String. The calling designer component can use <see cref="M:System.Web.UI.Design.DesignTimeData.GetDesignTimeDataSource(System.Data.DataTable,System.Int32)" /> to add rows of data to the resulting table.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a <see cref="T:System.Data.DataTable" /> object with the same schema as the provided data and optionally containing column names indicating that the data is bound data.</para> + </summary> + <param name="referenceData"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IEnumerable" /> object containing data.</param> + <param name="useDataBoundData"> + <attribution license="cc4" from="Microsoft" modified="false" />If true, the column names indicate that they contain bound data.</param> </Docs> </Member> <Member MemberName="DataBindingHandler"> @@ -95,8 +126,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an event handler for data binding.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -113,10 +147,14 @@ <Parameter Name="dataSource" Type="System.Collections.IEnumerable" /> </Parameters> <Docs> - <param name="dataSource">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of property descriptors for the data fields of the specified data source.</para> + </summary> + <param name="dataSource"> + <attribution license="cc4" from="Microsoft" modified="false" />The data source from which to retrieve the data fields. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -134,11 +172,19 @@ <Parameter Name="dataMember" Type="System.String" /> </Parameters> <Docs> - <param name="dataSource">To be added.</param> - <param name="dataMember">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method searches the specified data source for the specified data member. If <paramref name="dataMember" /> is null, the first data member in the specified data source is returned.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the specified data member from the specified data source.</para> + </summary> + <param name="dataSource"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.IListSource" /> that contains the data in which to find the member. </param> + <param name="dataMember"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the data member to retrieve. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -155,10 +201,14 @@ <Parameter Name="dataSource" Type="System.Object" /> </Parameters> <Docs> - <param name="dataSource">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the names of the data members in the specified data source.</para> + </summary> + <param name="dataSource"> + <attribution license="cc4" from="Microsoft" modified="false" />The data source from which to retrieve the names of the members. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -176,11 +226,16 @@ <Parameter Name="minimumRows" Type="System.Int32" /> </Parameters> <Docs> - <param name="dataTable">To be added.</param> - <param name="minimumRows">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the specified number of sample rows to the specified data table.</para> + </summary> + <param name="dataTable"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataTable" /> object to which the sample rows are added. </param> + <param name="minimumRows"> + <attribution license="cc4" from="Microsoft" modified="false" />The minimum number of rows to add. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -198,11 +253,16 @@ <Parameter Name="dataSource" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="dataSource">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a data source selected by name in the design host, represented by the specified component's site property and identified by the specified data source name.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> object that contains the data source. </param> + <param name="dataSource"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the data source to retrieve. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -221,12 +281,18 @@ <Parameter Name="dataMember" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="dataSource">To be added.</param> - <param name="dataMember">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a data source selected by name in the design host, represented by the specified component's site property and identified by the specified data-source name and member name.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The object implementing <see cref="T:System.ComponentModel.IComponent" /> that contains the data sourced property. </param> + <param name="dataSource"> + <attribution license="cc4" from="Microsoft" modified="false" />The data source to retrieve. </param> + <param name="dataMember"> + <attribution license="cc4" from="Microsoft" modified="false" />The data member to retrieve. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -234,4 +300,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignTimeResourceProviderFactory.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignTimeResourceProviderFactory.xml index 30316e273cb..31d2123cd48 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignTimeResourceProviderFactory.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignTimeResourceProviderFactory.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignTimeResourceProviderFactory" FullName="System.Web.UI.Design.DesignTimeResourceProviderFactory"> <TypeSignature Language="C#" Value="public abstract class DesignTimeResourceProviderFactory" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Used by control localization to read and write resources at design time. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new instance of the <see cref="T:System.Web.UI.Design.DesignTimeResourceProviderFactory" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="CreateDesignTimeGlobalResourceProvider"> @@ -39,11 +46,16 @@ <Parameter Name="classKey" Type="System.String" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <param name="classKey">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, creates a global resource provider using the provided <see cref="T:System.IServiceProvider" /> interface and resource class name.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A reference to the design host.</param> + <param name="classKey"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the resource class.</param> </Docs> </Member> <Member MemberName="CreateDesignTimeLocalResourceProvider"> @@ -59,10 +71,14 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, creates a local resource provider using the provided reference to the design host.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A reference to the design host.</param> </Docs> </Member> <Member MemberName="CreateDesignTimeLocalResourceWriter"> @@ -78,11 +94,15 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, creates a local resource writer for using the provided reference to the design host.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A reference to the design host.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormat.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormat.xml index be209b4f7c9..27aa4b0da9c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormat.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormat.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerAutoFormat" FullName="System.Web.UI.Design.DesignerAutoFormat"> <TypeSignature Language="C#" Value="public abstract class DesignerAutoFormat" /> <AssemblyInfo> @@ -9,8 +10,43 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> provides a base class that can be inherited from and extended to display a formatted custom Web server control at design time in a visual designer tool such as vsprvslong.</para> + <para>A control developer provides automatic formatting in order to help developers who use the control to select a preferred display. A custom <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object works with a custom control designer to provide automatic formatting at design time for a custom control. For example, the <see cref="T:System.Web.UI.WebControls.Calendar" /> control provides a variety of formats that can be applied by a developer at design time.</para> + <para>To implement automatic formatting for a custom control:</para> + <list type="ordered"> + <item> + <para>Create the custom control.</para> + </item> + <item> + <para>Derive a designer class from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class or another designer class that is appropriate for your control, such as the <see cref="T:System.Web.UI.Design.TextControlDesigner" />.</para> + </item> + <item> + <para>Derive a format class from the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> class that formats your custom control by overriding the <see cref="M:System.Web.UI.Design.DesignerAutoFormat.Apply(System.Web.UI.Control)" /> method.</para> + </item> + <item> + <para>In your designer class, populate the <see cref="P:System.Web.UI.Design.ControlDesigner.AutoFormats" /> property, which is a <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object, with one instance of your format class for each named format that your designer can apply.</para> + </item> + </list> + <para>The <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> class provides the following members to support automatic formatting at design time:</para> + <list type="bullet"> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormat.Apply(System.Web.UI.Control)" /> method, which applies the named format to the specified control.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormat.GetPreviewControl(System.Web.UI.Control)" /> method, which provides a copy of the control for previewing in an <ui>AutoFormat</ui> dialog box of a visual designer such as vsprvslong.</para> + </item> + <item> + <para>The <see cref="P:System.Web.UI.Design.DesignerAutoFormat.Name" /> property, which provides the text to display in a list of formats in a visual designer.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides the abstract base class for creating formats that can be applied to a custom Web server control at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +59,16 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.DesignerAutoFormat.#ctor(System.String)" /> constructor to create a new format and add it to a <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> collection that is represented by the <see cref="P:System.Web.UI.Design.ControlDesigner.AutoFormats" /> property of a <see cref="T:System.Web.UI.Design.ControlDesigner" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> class.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />A string that identifies a specific <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object.</param> </Docs> </Member> <Member MemberName="Apply"> @@ -41,9 +84,16 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormat.Apply(System.Web.UI.Control)" /> method applies formatting to the specified control based on the <see cref="P:System.Web.UI.Design.DesignerAutoFormat.Name" /> property. You can apply the styles directly to the control, or set the <see cref="P:System.Web.UI.Design.DesignerAutoFormat.Style" /> property and then use the <see cref="M:System.Web.UI.WebControls.WebControl.MergeStyle(System.Web.UI.WebControls.Style)" /> method for the control to apply the style changes to the control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Applies the associated formatting to the specified control.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />A Web server control to apply the formatting to.</param> </Docs> </Member> <Member MemberName="GetPreviewControl"> @@ -59,10 +109,18 @@ <Parameter Name="runtimeControl" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="runtimeControl">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormat.GetPreviewControl(System.Web.UI.Control)" /> method is used by visual designers, such as vsprvslong, in an <ui>AutoFormat</ui> dialog box to display a formatted run-time preview of the control at design time before applying the format to the actual control.</para> + <para>Regardless of the setting of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute for the <see cref="T:System.Web.UI.Design.ControlDesigner" /> object, the <see cref="M:System.Web.UI.Design.DesignerAutoFormat.GetPreviewControl(System.Web.UI.Control)" /> method returns a copy of the control in the <paramref name="runtimeControl" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a copy of the associated control in order to provide a preview before applying the format to the control.</para> + </summary> + <param name="runtimeControl"> + <attribution license="cc4" from="Microsoft" modified="false" />A run-time version of the Web server control.</param> </Docs> </Member> <Member MemberName="Name"> @@ -75,9 +133,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A visual designer, such as vsprvslong, uses the <see cref="P:System.Web.UI.Design.DesignerAutoFormat.Name" /> property from each <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object in the <see cref="P:System.Web.UI.Design.ControlDesigner.AutoFormats" /> collection of a <see cref="T:System.Web.UI.Design.ControlDesigner" /> to create a list of available automatic style formats.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of a <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object.</para> + </summary> </Docs> </Member> <Member MemberName="Style"> @@ -90,9 +154,15 @@ <ReturnType>System.Web.UI.Design.DesignerAutoFormatStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Although the object returned by the <see cref="P:System.Web.UI.Design.DesignerAutoFormat.Style" /> property is read-only, each individual property that it contains can be set. For example, you can set the <see cref="P:System.Web.UI.WebControls.Style.ForeColor" /> or <see cref="P:System.Web.UI.Design.DesignerAutoFormatStyle.VerticalAlign" /> property of the <see cref="T:System.Web.UI.Design.DesignerAutoFormatStyle" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a <see cref="T:System.Web.UI.Design.DesignerAutoFormatStyle" /> object that is used by the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object to render a design-time preview of the associated control.</para> + </summary> </Docs> </Member> <Member MemberName="ToString"> @@ -106,10 +176,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormat.ToString" /> method returns a string that contains the value of the <see cref="P:System.Web.UI.Design.DesignerAutoFormat.Name" /> property of the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a string that represents the current <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormatCollection.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormatCollection.xml index f06f892ce46..da7bc87de49 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormatCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormatCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerAutoFormatCollection" FullName="System.Web.UI.Design.DesignerAutoFormatCollection"> <TypeSignature Language="C#" Value="public sealed class DesignerAutoFormatCollection : System.Collections.IList" /> <AssemblyInfo> @@ -13,8 +14,48 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class and any derived class defines the <see cref="P:System.Web.UI.Design.ControlDesigner.AutoFormats" /> property as a <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object. Control developers can override the <see cref="P:System.Web.UI.Design.ControlDesigner.AutoFormats" /> property in a derived control designer, add custom automatic formatting styles, and return the collection of supported formats to the visual designer.</para> + <para>The collection dynamically increases as objects are added. Indexes in this collection are zero-based. Use the <see cref="P:System.Web.UI.Design.DesignerAutoFormatCollection.Count" /> property to determine how many automatic style formats are in the collection.</para> + <para>Additionally, use the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> methods and properties to provide the following functionality:</para> + <list type="bullet"> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Add(System.Web.UI.Design.DesignerAutoFormat)" /> method to add a single format to the collection. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Insert(System.Int32,System.Web.UI.Design.DesignerAutoFormat)" /> method to add a format at a particular index within the collection.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Remove(System.Web.UI.Design.DesignerAutoFormat)" /> method to remove a format. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.RemoveAt(System.Int32)" /> method to remove the format at a particular index.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Contains(System.Web.UI.Design.DesignerAutoFormat)" /> method to determine whether a particular format is already in the collection. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.IndexOf(System.Web.UI.Design.DesignerAutoFormat)" /> method to retrieve the index of a format within the collection. </para> + </item> + <item> + <para>The <see cref="P:System.Web.UI.Design.DesignerAutoFormatCollection.Item(System.Int32)" /> property to get or set the format at a particular index, using array notation.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Clear" /> method to remove all formats from the collection.</para> + </item> + <item> + <para>The <see cref="P:System.Web.UI.Design.DesignerAutoFormatCollection.Count" /> property to determine the number of formats in the collection.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.IndexOf(System.Web.UI.Design.DesignerAutoFormat)" /> method to get the position of a format within the collection.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a collection of <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> objects within a control designer. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,8 +66,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> constructor to create an empty collection. You can add elements to the collection by using the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Add(System.Web.UI.Design.DesignerAutoFormat)" /> or <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Insert(System.Int32,System.Web.UI.Design.DesignerAutoFormat)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Add"> @@ -42,10 +89,17 @@ <Parameter Name="format" Type="System.Web.UI.Design.DesignerAutoFormat" /> </Parameters> <Docs> - <param name="format">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Add(System.Web.UI.Design.DesignerAutoFormat)" /> method adds the specified <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object to the end of the collection. To add a <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object to the collection at a specific index location, use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Insert(System.Int32,System.Web.UI.Design.DesignerAutoFormat)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the specified <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object to the end of the collection.</para> + </summary> + <param name="format"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of <see cref="T:System.Web.UI.Design.DesignerAutoFormat" />.</param> </Docs> </Member> <Member MemberName="Clear"> @@ -59,8 +113,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Clear" /> method to remove all formats from the collection. To remove a specific format from the collection, use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Remove(System.Web.UI.Design.DesignerAutoFormat)" /> method. To remove a format at a particular index, use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.RemoveAt(System.Int32)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes all formats from the collection.</para> + </summary> </Docs> </Member> <Member MemberName="Contains"> @@ -76,10 +136,17 @@ <Parameter Name="format" Type="System.Web.UI.Design.DesignerAutoFormat" /> </Parameters> <Docs> - <param name="format">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Contains(System.Web.UI.Design.DesignerAutoFormat)" /> method determines equality by using the <see cref="M:System.Object.Equals(System.Object)" /> method on the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> objects that are being compared.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the specified format is contained within the collection.</para> + </summary> + <param name="format"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of <see cref="T:System.Web.UI.Design.DesignerAutoFormat" />.</param> </Docs> </Member> <Member MemberName="Count"> @@ -92,9 +159,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DesignerAutoFormatCollection.Count" /> property typically is used to determine the upper boundary index when iterating through objects in the collection. Because the collection indexes are zero-based, the first element is at index 0 and the last element is at index Count-1.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> objects in the collection.</para> + </summary> </Docs> </Member> <Member MemberName="IndexOf"> @@ -110,10 +183,17 @@ <Parameter Name="format" Type="System.Web.UI.Design.DesignerAutoFormat" /> </Parameters> <Docs> - <param name="format">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.IndexOf(System.Web.UI.Design.DesignerAutoFormat)" /> method determines equality by using the <see cref="M:System.Object.Equals(System.Object)" /> method on the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> objects that are being compared.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the index of the specified <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object within the collection.</para> + </summary> + <param name="format"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> to locate within the collection.</param> </Docs> </Member> <Member MemberName="Insert"> @@ -130,10 +210,21 @@ <Parameter Name="format" Type="System.Web.UI.Design.DesignerAutoFormat" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="format">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Insert(System.Int32,System.Web.UI.Design.DesignerAutoFormat)" /> method adds a <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object to the collection at a specific index location. To add a single <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> to the end of the collection, use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Add(System.Web.UI.Design.DesignerAutoFormat)" /> method.</para> + <block subset="none" type="note"> + <para>When you insert an item into a collection, the index values change for subsequent items in the collection.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts a <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object into the collection at the specified index.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index within the collection at which to insert <paramref name="format" />.</param> + <param name="format"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> to insert into the collection.</param> </Docs> </Member> <Member MemberName="Item"> @@ -165,9 +256,15 @@ <ReturnType>System.Drawing.Size</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DesignerAutoFormatCollection.PreviewSize" /> property examines each format in the collection and returns the largest height and the largest width in a <see cref="T:System.Drawing.Size" /> structure. A visual designer, such as vsprvslong, uses the <see cref="P:System.Web.UI.Design.DesignerAutoFormatCollection.PreviewSize" /> to determine the initial size of the <ui>AutoFormat</ui> dialog box. The minimum size is 200-by-200 pixels.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the maximum outer dimensions of the control as it will appear at run time.</para> + </summary> </Docs> </Member> <Member MemberName="Remove"> @@ -183,9 +280,22 @@ <Parameter Name="format" Type="System.Web.UI.Design.DesignerAutoFormat" /> </Parameters> <Docs> - <param name="format">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Remove(System.Web.UI.Design.DesignerAutoFormat)" /> method removes the first occurrence of <paramref name="format" /> from the collection. If the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object does not contain <paramref name="format" />, the collection remains unchanged. No exception is thrown.</para> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Remove(System.Web.UI.Design.DesignerAutoFormat)" /> method determines equality by using the <see cref="M:System.Object.Equals(System.Object)" /> method on the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> objects that are being compared.</para> + <para>The <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Remove(System.Web.UI.Design.DesignerAutoFormat)" /> method performs a linear search; therefore, the average execution time is proportional to the <see cref="P:System.Web.UI.Design.DesignerAutoFormatCollection.Count" /> value.</para> + <para>To remove a format at a particular index from the collection, use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.RemoveAt(System.Int32)" /> method. To remove all formats from the collection, use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Clear" /> method.</para> + <block subset="none" type="note"> + <para>When you remove an item from a collection, the index values change for subsequent items in the collection.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object from the collection.</para> + </summary> + <param name="format"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> to remove from the collection.</param> </Docs> </Member> <Member MemberName="RemoveAt"> @@ -201,9 +311,19 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.RemoveAt(System.Int32)" /> method to remove a format at a particular index from the collection. To remove a specified format from the collection, use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Remove(System.Web.UI.Design.DesignerAutoFormat)" /> method. To remove all formats from the collection, use the <see cref="M:System.Web.UI.Design.DesignerAutoFormatCollection.Clear" /> method.</para> + <block subset="none" type="note"> + <para>When you remove an item from a collection, the index values change for subsequent items in the collection.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object at the specified index within the collection.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index of the <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> to remove from the collection.</param> </Docs> </Member> <Member MemberName="SyncRoot"> @@ -216,9 +336,16 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enumerating through a collection is not a thread-safe procedure intrinsically. Even when a collection is synchronized, other threads can still modify the collection. This causes exceptions during enumeration.</para> + <para>Lock the collection by using the <see cref="P:System.Web.UI.Design.DesignerAutoFormatCollection.SyncRoot" /> method during the entire enumeration to guarantee thread safety. For detailed information about locking collections for thread-safe access, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an object that can be used to synchronize access to the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.ICollection.CopyTo"> @@ -235,10 +362,18 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the elements of the collection to an <see cref="T:System.Array" /> object, starting at a particular <see cref="T:System.Array" /> index when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Array" /> to receive the designated items.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The starting index for the items to copy.</param> </Docs> </Member> <Member MemberName="System.Collections.ICollection.Count"> @@ -251,9 +386,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of elements that are contained in the collection when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.ICollection.IsSynchronized"> @@ -266,9 +407,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether access to the collection is synchronized (thread safe) when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IEnumerable.GetEnumerator"> @@ -282,9 +429,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IEnumerable" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an <see cref="T:System.Collections.IEnumerator" /> interface that iterates through the collection when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IEnumerable" /> interface.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Add"> @@ -301,9 +454,15 @@ </Parameters> <Docs> <param name="item">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds an item to the collection when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Contains"> @@ -320,9 +479,15 @@ </Parameters> <Docs> <param name="item">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the collection contains a specific value when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.IndexOf"> @@ -339,9 +504,15 @@ </Parameters> <Docs> <param name="item">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines the index of a specific item in the collection when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Insert"> @@ -358,10 +529,17 @@ <Parameter Name="item" Type="System.Object" /> </Parameters> <Docs> - <param name="index">To be added.</param> <param name="item">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts an item into the collection at the specified index when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The index at which to insert <paramref name="value" />.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.IsFixedSize"> @@ -374,9 +552,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the collection has a fixed size when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.IsReadOnly"> @@ -389,9 +573,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this method, see <see cref="P:System.Collections.IList.IsReadOnly" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Item"> @@ -427,8 +617,14 @@ </Parameters> <Docs> <param name="item">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the first occurrence of a specific object from the collection when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.RemoveAt"> @@ -444,10 +640,17 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the item at the specified index when the <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> object is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The index of the item to remove.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormatStyle.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormatStyle.xml index 1332e4118b0..2f0ec685097 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormatStyle.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerAutoFormatStyle.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerAutoFormatStyle" FullName="System.Web.UI.Design.DesignerAutoFormatStyle"> <TypeSignature Language="C#" Value="public class DesignerAutoFormatStyle : System.Web.UI.WebControls.Style" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.DesignerAutoFormatStyle" /> class encapsulates the properties that control the appearance of a Web server control for automatic formatting at design time. You can specify the background color, font color, and the vertical alignment of a control by setting the <see cref="P:System.Web.UI.WebControls.Style.BackColor" />, <see cref="P:System.Web.UI.WebControls.Style.ForeColor" />, and <see cref="P:System.Web.UI.Design.DesignerAutoFormatStyle.VerticalAlign" /> properties, respectively.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the style for a <see cref="T:System.Web.UI.Design.DesignerAutoFormat" /> object. This class is used primarily by control developers.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +28,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerAutoFormatStyle" /> class using default values.</para> + </summary> </Docs> </Member> <Member MemberName="VerticalAlign"> @@ -35,10 +45,16 @@ <ReturnType>System.Web.UI.WebControls.VerticalAlign</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="T:System.Web.UI.WebControls.VerticalAlign" /> property to specify the vertical alignment of the contents for the associated control. If the <see cref="T:System.Web.UI.WebControls.VerticalAlign" /> property does not apply to an associated control, the setting is ignored. For the defined values for the vertical alignment enumeration, see <see cref="T:System.Web.UI.WebControls.VerticalAlign" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the vertical alignment of the contents for the associated control.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerDataSourceView.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerDataSourceView.xml index c809c835eb2..a336720fd55 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerDataSourceView.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerDataSourceView.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerDataSourceView" FullName="System.Web.UI.Design.DesignerDataSourceView"> <TypeSignature Language="C#" Value="public abstract class DesignerDataSourceView" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serves as the base class for design-time data source view classes. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +28,15 @@ <Parameter Name="viewName" Type="System.String" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="viewName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerDataSourceView" /> class using the specified data source designer and view name.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent data source designer.</param> + <param name="viewName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the view in the data source.</param> </Docs> </Member> <Member MemberName="CanDelete"> @@ -40,9 +49,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Web.UI.DataSourceView" /> object that is associated with the current <see cref="T:System.Web.UI.DataSourceControl" /> object supports the <see cref="M:System.Web.UI.DataSourceView.ExecuteDelete(System.Collections.IDictionary,System.Collections.IDictionary)" /> method.</para> + </summary> </Docs> </Member> <Member MemberName="CanInsert"> @@ -55,9 +67,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Web.UI.DataSourceView" /> object that is associated with the current <see cref="T:System.Web.UI.DataSourceControl" /> object supports the <see cref="M:System.Web.UI.DataSourceView.ExecuteInsert(System.Collections.IDictionary)" /> method.</para> + </summary> </Docs> </Member> <Member MemberName="CanPage"> @@ -70,9 +85,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Web.UI.DataSourceView" /> object that is associated with the current <see cref="T:System.Web.UI.DataSourceControl" /> object supports paging through the data that is retrieved by the <see cref="M:System.Web.UI.DataSourceView.ExecuteSelect(System.Web.UI.DataSourceSelectArguments)" /> method.</para> + </summary> </Docs> </Member> <Member MemberName="CanRetrieveTotalRowCount"> @@ -85,9 +103,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Web.UI.DataSourceView" /> object that is associated with the current <see cref="T:System.Web.UI.DataSourceControl" /> object supports retrieving the total number of data rows instead of the data itself.</para> + </summary> </Docs> </Member> <Member MemberName="CanSort"> @@ -100,9 +121,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Web.UI.DataSourceView" /> object that is associated with the current <see cref="T:System.Web.UI.DataSourceControl" /> object supports a sorted view on the underlying data source.</para> + </summary> </Docs> </Member> <Member MemberName="CanUpdate"> @@ -115,9 +139,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Web.UI.DataSourceView" /> object that is associated with the current <see cref="T:System.Web.UI.DataSourceControl" /> object supports the <see cref="M:System.Web.UI.DataSourceView.ExecuteUpdate(System.Collections.IDictionary,System.Collections.IDictionary,System.Collections.IDictionary)" /> method.</para> + </summary> </Docs> </Member> <Member MemberName="DataSourceDesigner"> @@ -130,9 +157,12 @@ <ReturnType>System.Web.UI.Design.IDataSourceDesigner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a reference to the designer that created this <see cref="T:System.Web.UI.Design.DesignerDataSourceView" /> control.</para> + </summary> </Docs> </Member> <Member MemberName="GetDesignTimeData"> @@ -166,9 +196,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the view as provided when this instance of the <see cref="T:System.Web.UI.Design.DesignerDataSourceView" /> class was created.</para> + </summary> </Docs> </Member> <Member MemberName="Schema"> @@ -181,10 +214,13 @@ <ReturnType>System.Web.UI.Design.IDataSourceViewSchema</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a schema that describes the data source view that is represented by this view object.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerHierarchicalDataSourceView.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerHierarchicalDataSourceView.xml index 3791af80c30..1f013302584 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerHierarchicalDataSourceView.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerHierarchicalDataSourceView.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerHierarchicalDataSourceView" FullName="System.Web.UI.Design.DesignerHierarchicalDataSourceView"> <TypeSignature Language="C#" Value="public abstract class DesignerHierarchicalDataSourceView" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.DesignerHierarchicalDataSourceView" /> class is used by developers of custom data source designers.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base class for designers for data views based on hierarchical data. This class must be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +31,15 @@ <Parameter Name="viewPath" Type="System.String" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="viewPath">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initiates a new instance of the <see cref="T:System.Web.UI.Design.DesignerHierarchicalDataSourceView" /> class.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.IHierarchicalDataSourceDesigner" /> that is the designer for the associated control.</param> + <param name="viewPath"> + <attribution license="cc4" from="Microsoft" modified="false" />A unique path to the block of data to use for the view.</param> </Docs> </Member> <Member MemberName="DataSourceDesigner"> @@ -40,9 +52,12 @@ <ReturnType>System.Web.UI.Design.IHierarchicalDataSourceDesigner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the associated designer.</para> + </summary> </Docs> </Member> <Member MemberName="GetDesignTimeData"> @@ -74,9 +89,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The specific nature of the <see cref="P:System.Web.UI.Design.DesignerHierarchicalDataSourceView.Path" /> property is determined by the nature of the data. For XML data, it would be an XPath query, but for other kinds of data it could be a URL or some other unique identifying path.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the path to the block of data that is presented in the view.</para> + </summary> </Docs> </Member> <Member MemberName="Schema"> @@ -89,10 +110,16 @@ <ReturnType>System.Web.UI.Design.IDataSourceSchema</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DesignerHierarchicalDataSourceView.Schema" /> property allows the control designer of a data-bound control to provide intelligent choices based on the design-time data source view that is selected for data binding.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a schema that describes the data source view for the associated control.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerObject.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerObject.xml index 296c7f692b9..aeb75bf625f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerObject.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerObject.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerObject" FullName="System.Web.UI.Design.DesignerObject"> <TypeSignature Language="C#" Value="public abstract class DesignerObject : IServiceProvider" /> <AssemblyInfo> @@ -13,8 +14,11 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents an object in a design host such as vsprvslong. This class must be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -28,10 +32,15 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="name">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerObject" /> class.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent designer.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the object.</param> </Docs> </Member> <Member MemberName="Designer"> @@ -44,9 +53,12 @@ <ReturnType>System.Web.UI.Design.ControlDesigner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the associated designer component.</para> + </summary> </Docs> </Member> <Member MemberName="GetService"> @@ -62,10 +74,14 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a service from the design host, as identified by the provided type.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of service being requested.</param> </Docs> </Member> <Member MemberName="Name"> @@ -78,9 +94,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the object.</para> + </summary> </Docs> </Member> <Member MemberName="Properties"> @@ -93,9 +112,12 @@ <ReturnType>System.Collections.IDictionary</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the object's properties.</para> + </summary> </Docs> </Member> <Member MemberName="System.IServiceProvider.GetService"> @@ -111,11 +133,15 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.IServiceProvider.GetService(System.Type)" />.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of service being requested.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegion.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegion.xml index 82df0baf81e..05b821e19c3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegion.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegion.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerRegion" FullName="System.Web.UI.Design.DesignerRegion"> <TypeSignature Language="C#" Value="public class DesignerRegion : System.Web.UI.Design.DesignerObject" /> <AssemblyInfo> @@ -9,8 +10,17 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.DesignerRegion" /> object represents a region of content within the design-time markup that is generated by a <see cref="T:System.Web.UI.Design.ControlDesigner" /> implementation. A control developer uses designer regions in a custom <see cref="T:System.Web.UI.Design.ControlDesigner" /> implementation to define separate areas within the design-time markup for the associated control and to provide editing and event handling for the area. A visual designer, such as vsprvslong, can use designer regions to display the separate areas of a control on the design surface and to raise user events for the region to the control designer. Designer regions can simplify a control designer implementation because many region-based features are provided by the base designer classes and the visual designer.</para> + <para>The <see cref="T:System.Web.UI.Design.DesignerRegion" /> class provides the base functionality for designer regions, such as the ability to click, select, and highlight a region in the design surface. Use a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object in a control designer implementation to define a region that does not require editing. Use the derived <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> class in a control designer implementation to define a region with editable content at design time. Use the derived <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> class in a control designer implementation to define an editable region that represents a template in a control.</para> + <para>To support regions within a class that is derived from the <see cref="T:System.Web.UI.Design.ControlDesigner" />, override the <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method and add one or more initialized <see cref="T:System.Web.UI.Design.DesignerRegion" /> objects to the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> collection. Optionally, you can handle mouse clicks in the regions on the design surface by overriding the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method.</para> + <para>Use the properties of a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object to determine how the region is displayed by the visual designer. Override the <see cref="P:System.Web.UI.Design.DesignerRegion.Selectable" /> property to indicate that the region can be selected by the user on the design surface. Use the <see cref="P:System.Web.UI.Design.DesignerRegion.Highlight" /> property to highlight the designer region in the visual designer; for example, you can highlight a region after a user has clicked to select it. Use the <see cref="P:System.Web.UI.Design.DesignerRegion.DisplayName" /> and <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> properties to store or retrieve additional details about the region. In particular, the <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> property is used by the visual designer to display ToolTip information when the user moves the mouse pointer over the designer region. Use the <see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> property to access the methods and properties of the control designer object that contains the designer region.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines a region of content within the design-time markup for the associated control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +34,127 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="name">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The following table shows the initial property values for an instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Property</para> + </term> + <description> + <para>Initial Value</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> + </para> + </term> + <description> + <para>An empty string ("").</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> </para> + </term> + <description> + <para>The input <paramref name="designer" /> object.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.DisplayName" /> + </para> + </term> + <description> + <para>An empty string ("").</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.EnsureSize" /> + </para> + </term> + <description> + <para>false.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.Highlight" /> + </para> + </term> + <description> + <para>false.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerObject.Name" /> </para> + </term> + <description> + <para>The input <paramref name="name" /> object.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerObject.Properties" /> </para> + </term> + <description> + <para>An empty <see cref="T:System.Collections.Specialized.HybridDictionary" /> object.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.Selectable" /> + </para> + </term> + <description> + <para>false.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.Selected" /> + </para> + </term> + <description> + <para>false.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> + </para> + </term> + <description> + <para>null.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class with the specified name for a control designer.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The control designer that contains this designer region.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of this designer region.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -42,11 +169,129 @@ <Parameter Name="selectable" Type="System.Boolean" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="name">To be added.</param> - <param name="selectable">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The following table shows the initial property values for an instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Property</para> + </term> + <description> + <para>Initial Value</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> + </para> + </term> + <description> + <para>An empty string ("").</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> </para> + </term> + <description> + <para>The input <paramref name="designer" /> object.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.DisplayName" /> + </para> + </term> + <description> + <para>An empty string ("").</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.EnsureSize" /> + </para> + </term> + <description> + <para>false.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.Highlight" /> + </para> + </term> + <description> + <para>false.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerObject.Name" /> </para> + </term> + <description> + <para>The input <paramref name="name" /> object.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerObject.Properties" /> </para> + </term> + <description> + <para>An empty <see cref="T:System.Collections.Specialized.HybridDictionary" /> object.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.Selectable" /> + </para> + </term> + <description> + <para>The input <paramref name="selectable" /> value.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.Selected" /> + </para> + </term> + <description> + <para>false.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> + </para> + </term> + <description> + <para>null.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class with the specified name for a control designer, optionally setting the instance as a selectable region in the designer.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The control designer that contains this designer region.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of this designer region.</param> + <param name="selectable"> + <attribution license="cc4" from="Microsoft" modified="false" />true to select the region; otherwise, false.</param> </Docs> </Member> <Member MemberName="Description"> @@ -59,9 +304,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> property is used by the design host to display ToolTip information when the user moves the mouse pointer over the designer region.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the description for a designer region.</para> + </summary> </Docs> </Member> <Member MemberName="DesignerRegionAttributeName"> @@ -75,8 +326,14 @@ </ReturnValue> <MemberValue>null</MemberValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The attribute name for a designer region is _designerRegion. The <see cref="F:System.Web.UI.Design.DesignerRegion.DesignerRegionAttributeName" /> field is used to identify regions within the design-time HTML markup for the control designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines the HTML attribute name for a designer region.</para> + </summary> </Docs> </Member> <Member MemberName="DisplayName"> @@ -89,9 +346,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the friendly display name for a designer region.</para> + </summary> </Docs> </Member> <Member MemberName="EnsureSize"> @@ -104,9 +364,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 the region size is to be explicitly set on the designer region by the design host.</para> + </summary> </Docs> </Member> <Member MemberName="GetBounds"> @@ -120,9 +383,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegion.GetBounds" /> method returns a value that is equivalent to calling the <see cref="M:System.Web.UI.Design.IControlDesignerView.GetBounds(System.Web.UI.Design.DesignerRegion)" /> method on the <see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> object with this designer region.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the size of the designer region on the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="Highlight"> @@ -135,9 +404,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 to highlight the designer region on the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="Selectable"> @@ -150,9 +422,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 the designer region can be selected by the user on the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="Selected"> @@ -165,9 +440,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 the designer region is currently selected on the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="UserData"> @@ -180,10 +458,17 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Within a control designer implementation, use the <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> property to store or retrieve additional information for the designer region.</para> + <para>For example, if the control designer implementation supports selecting from multiple designer regions, you can use the <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> property in a control designer to store a unique index for each region. You can then use the <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> property for the region that is passed into the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method to store the index for the currently selected region.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets optional user data to associate with the designer region.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegionCollection.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegionCollection.xml index 1b50ba6003b..ef83c4742ca 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegionCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegionCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerRegionCollection" FullName="System.Web.UI.Design.DesignerRegionCollection"> <TypeSignature Language="C#" Value="public class DesignerRegionCollection : System.Collections.IList" /> <AssemblyInfo> @@ -13,8 +14,43 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class, and any derived class, uses the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> class to contain and enumerate the designer regions for the control in a design host, such as vsprvslong. </para> + <para>For example, the <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml" /> method can be used to define and add regions to the collection.</para> + <para>Use the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Owner" /> property to access the control designer object that contains the designer region collection. Use the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> methods and properties to examine and maintain the <see cref="T:System.Web.UI.Design.DesignerRegion" /> objects that are in the collection.</para> + <para>The collection dynamically increases as objects are added. Indexes in this collection are zero-based. Use the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Count" /> property to determine how many designer regions are in the collection. Use the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> members to provide the following functionality: </para> + <list type="bullet"> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Add(System.Web.UI.Design.DesignerRegion)" /> method to add a single designer region to the collection. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Insert(System.Int32,System.Web.UI.Design.DesignerRegion)" /> method to add a designer region at a particular index within the collection. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Remove(System.Web.UI.Design.DesignerRegion)" /> method to remove a designer region. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.RemoveAt(System.Int32)" /> method to remove the designer region at a particular index.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Contains(System.Web.UI.Design.DesignerRegion)" /> method to determine whether a particular designer region is already in the collection. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.IndexOf(System.Web.UI.Design.DesignerRegion)" /> method to retrieve the index of a designer region within the collection. </para> + </item> + <item> + <para>The <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Item(System.Int32)" /> indexer to get or set the designer region at a particular index, using array notation.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Clear" /> method to remove all designer regions from the collection.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a collection of <see cref="T:System.Web.UI.Design.DesignerRegion" /> objects within a control designer.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,8 +61,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.#ctor" /> constructor to create an empty collection. You can add elements to the collection by using the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Add(System.Web.UI.Design.DesignerRegion)" /> or <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Insert(System.Int32,System.Web.UI.Design.DesignerRegion)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> class.</para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -39,9 +81,17 @@ <Parameter Name="owner" Type="System.Web.UI.Design.ControlDesigner" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.#ctor(System.Web.UI.Design.ControlDesigner)" /> constructor creates an empty collection and sets the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Owner" /> property to the specified control designer object. The visual designer, such as vsprvslong, uses the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.#ctor(System.Web.UI.Design.ControlDesigner)" /> constructor to initialize a designer region collection for a specific control designer.</para> + <para>You can add elements to the collection by using the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Add(System.Web.UI.Design.DesignerRegion)" /> or <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Insert(System.Int32,System.Web.UI.Design.DesignerRegion)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> class for the specified control designer.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The control designer that owns this collection of designer regions.</param> </Docs> </Member> <Member MemberName="Add"> @@ -57,10 +107,17 @@ <Parameter Name="region" Type="System.Web.UI.Design.DesignerRegion" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Add(System.Web.UI.Design.DesignerRegion)" /> method adds the specified <see cref="T:System.Web.UI.Design.DesignerRegion" /> object to the end of the collection. To add a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object to the collection at a specific index location, use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Insert(System.Int32,System.Web.UI.Design.DesignerRegion)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the specified <see cref="T:System.Web.UI.Design.DesignerRegion" /> object to the end of the collection.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerRegion" /> to add to the collection.</param> </Docs> </Member> <Member MemberName="Clear"> @@ -74,8 +131,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Clear" /> method to remove all regions from the collection. To remove a specific region from the collection, use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Remove(System.Web.UI.Design.DesignerRegion)" /> method. To remove a region at a particular index, use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.RemoveAt(System.Int32)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes all regions from the collection.</para> + </summary> </Docs> </Member> <Member MemberName="Contains"> @@ -91,10 +154,18 @@ <Parameter Name="region" Type="System.Web.UI.Design.DesignerRegion" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Contains(System.Web.UI.Design.DesignerRegion)" /> method determines equality by using the <see cref="M:System.Object.Equals(System.Object)" /> method on the <see cref="T:System.Web.UI.Design.DesignerRegion" /> objects.</para> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Contains(System.Web.UI.Design.DesignerRegion)" /> method performs a linear search; therefore, the average execution time is proportional to the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Count" /> property. Because template region collections are typically small, the performance of the linear search operation is not critical.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the specified region is contained within the collection.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerRegion" /> to locate within the collection.</param> </Docs> </Member> <Member MemberName="CopyTo"> @@ -111,10 +182,18 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Add(System.Web.UI.Design.DesignerRegion)" /> or <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Insert(System.Int32,System.Web.UI.Design.DesignerRegion)" /> method to add the design regions to the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the elements of the collection to an <see cref="T:System.Array" /> object, starting at a particular <see cref="T:System.Array" /> index.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Array" /> that is the destination of the copied regions. The <see cref="T:System.Array" /> must have zero-based indexing.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param> </Docs> </Member> <Member MemberName="Count"> @@ -127,9 +206,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Count" /> property is commonly used to determine the upper boundary index when iterating through objects in the collection. Because the collection indexes are zero-based, the first element is at index 0 and the last element is at index Count-1.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of <see cref="T:System.Web.UI.Design.DesignerRegion" /> objects in the collection.</para> + </summary> </Docs> </Member> <Member MemberName="GetEnumerator"> @@ -143,9 +228,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Count" /> property together with a loop construct, such as while, for, or foreach statements, to enumerate through the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an enumerator that iterates through the collection.</para> + </summary> </Docs> </Member> <Member MemberName="IndexOf"> @@ -161,10 +252,18 @@ <Parameter Name="region" Type="System.Web.UI.Design.DesignerRegion" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.IndexOf(System.Web.UI.Design.DesignerRegion)" /> method determines equality by using the <see cref="M:System.Object.Equals(System.Object)" /> method on the <see cref="T:System.Web.UI.Design.DesignerRegion" /> objects.</para> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.IndexOf(System.Web.UI.Design.DesignerRegion)" /> method performs a linear search; therefore, the average execution time is proportional to the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Count" /> property. Because template region collections are typically small, the performance of the linear search operation is not critical.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the index of the specified <see cref="T:System.Web.UI.Design.DesignerRegion" /> object within the collection.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerRegion" /> to locate within the collection.</param> </Docs> </Member> <Member MemberName="Insert"> @@ -181,10 +280,21 @@ <Parameter Name="region" Type="System.Web.UI.Design.DesignerRegion" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="region">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Insert(System.Int32,System.Web.UI.Design.DesignerRegion)" /> method adds a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object to the collection at a specific index location. To add a single <see cref="T:System.Web.UI.Design.DesignerRegion" /> to the end of the collection, use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Add(System.Web.UI.Design.DesignerRegion)" /> method.</para> + <block subset="none" type="note"> + <para>When you insert an item into the collection, the indexes change for subsequent items in the collection.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object into the collection at the specified index.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index within the collection at which to insert the region.</param> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerRegion" /> to insert into the collection.</param> </Docs> </Member> <Member MemberName="IsFixedSize"> @@ -197,9 +307,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> object has a fixed size.</para> + </summary> </Docs> </Member> <Member MemberName="IsReadOnly"> @@ -212,9 +325,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> object is read-only.</para> + </summary> </Docs> </Member> <Member MemberName="IsSynchronized"> @@ -227,9 +343,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enumerating through a collection is not a thread-safe procedure intrinsically. Even when a collection is synchronized, other threads can still modify the collection. This causes exceptions during enumeration.</para> + <para>Lock the collection by using the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.SyncRoot" /> method during the whole enumeration to guarantee thread safety.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether access to the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> object is synchronized (thread safe).</para> + </summary> </Docs> </Member> <Member MemberName="Item"> @@ -261,9 +384,15 @@ <ReturnType>System.Web.UI.Design.ControlDesigner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Owner" /> property provides a convenient means to access the control designer object for a designer region collection. For example, you can use the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Owner" /> property to determine the type of control designer that owns the collection and to access the properties and methods of the control designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the control designer that owns the designer region collection.</para> + </summary> </Docs> </Member> <Member MemberName="Remove"> @@ -279,9 +408,22 @@ <Parameter Name="region" Type="System.Web.UI.Design.DesignerRegion" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Remove(System.Web.UI.Design.DesignerRegion)" /> method removes the first occurrence of the specified region from the collection. If the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> object does not contain the specified <paramref name="region" />, the collection remains unchanged. No exception is thrown.</para> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Remove(System.Web.UI.Design.DesignerRegion)" /> method determines equality by using the <see cref="M:System.Object.Equals(System.Object)" /> method on the <see cref="T:System.Web.UI.Design.DesignerRegion" /> object.</para> + <para>The <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Remove(System.Web.UI.Design.DesignerRegion)" /> method performs a linear search; therefore, the average execution time is proportional to the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.Count" /> property. Because template region collections are typically small, the performance of the linear search operation is not critical.</para> + <para>To remove a region at a particular index from the collection, use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.RemoveAt(System.Int32)" /> method. To remove all regions from the collection, use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Clear" /> method.</para> + <block subset="none" type="note"> + <para>When you remove an item from the collection, the indexes change for subsequent items in the collection.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified <see cref="T:System.Web.UI.Design.DesignerRegion" /> object from the collection. </para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerRegion" /> to remove from the collection. </param> </Docs> </Member> <Member MemberName="RemoveAt"> @@ -297,9 +439,19 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.RemoveAt(System.Int32)" /> method to remove a region at a particular index from the collection. To remove a specified region from the collection, use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Remove(System.Web.UI.Design.DesignerRegion)" /> method. To remove all regions from the collection, use the <see cref="M:System.Web.UI.Design.DesignerRegionCollection.Clear" /> method.</para> + <block subset="none" type="note"> + <para>When you remove an item from the collection, the indexes change for subsequent items in the collection.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the <see cref="T:System.Web.UI.Design.DesignerRegion" /> object at the specified index within the collection.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index within the collection of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> to remove.</param> </Docs> </Member> <Member MemberName="SyncRoot"> @@ -312,9 +464,16 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enumerating through a collection is not a thread-safe procedure intrinsically. Even when a collection is synchronized, other threads can still modify the collection. This causes exceptions during enumeration.</para> + <para>Lock the collection by using the <see cref="P:System.Web.UI.Design.DesignerRegionCollection.SyncRoot" /> method during the whole enumeration to guarantee thread safety. For detailed information about locking collections for thread-safe access, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an object that can be used to synchronize access to the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> object.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.ICollection.CopyTo"> @@ -331,10 +490,18 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)" />.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Array" /> that is the destination of the copied regions. The <see cref="T:System.Array" /> must have zero-based indexing.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param> </Docs> </Member> <Member MemberName="System.Collections.ICollection.Count"> @@ -347,9 +514,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.ICollection.IsSynchronized"> @@ -362,9 +535,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.ICollection.SyncRoot"> @@ -377,9 +556,15 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IEnumerable.GetEnumerator"> @@ -393,9 +578,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IEnumerable" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Add"> @@ -411,10 +602,17 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Add(System.Object)" />.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The item to add to the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.Clear"> @@ -428,8 +626,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Clear" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Contains"> @@ -445,10 +649,17 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Contains(System.Object)" />.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerRegion" /> to locate within the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.IndexOf"> @@ -464,10 +675,17 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.IndexOf(System.Object)" />.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerRegion" /> to locate within the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.Insert"> @@ -484,10 +702,18 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="o">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Insert(System.Int32,System.Object)" />.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index within the collection at which to insert the object.</param> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to insert into the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.IsFixedSize"> @@ -500,9 +726,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.IList.IsFixedSize" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.IsReadOnly"> @@ -515,9 +747,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.IList.IsReadOnly" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Item"> @@ -552,9 +790,16 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Remove(System.Object)" />.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to remove from the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.RemoveAt"> @@ -570,10 +815,17 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.RemoveAt(System.Int32)" />.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index within the collection of the object to remove.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegionMouseEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegionMouseEventArgs.xml index 0195365627b..074409ec692 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegionMouseEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegionMouseEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerRegionMouseEventArgs" FullName="System.Web.UI.Design.DesignerRegionMouseEventArgs"> <TypeSignature Language="C#" Value="public sealed class DesignerRegionMouseEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,8 +10,18 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event is raised by the designer host for certain actions on a control on the design surface. For example, an event is raised when you click a selected control or a designer region in a selected control on the design surface.</para> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default delegate to handle the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event. When you click a selected control or a designer region of a selected control at design time, the designer host initializes a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object for a <see cref="F:System.Web.UI.Design.ViewEvent.Click" /> event type, and then sets the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property with a <see cref="T:System.Web.UI.Design.DesignerRegionMouseEventArgs" /> object.</para> + <para>When the <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object indicates that you clicked a designer region, the default delegate in the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class passes the <see cref="T:System.Web.UI.Design.DesignerRegionMouseEventArgs" /> object to the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method. Classes deriving from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class override the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method to process events that are raised when you click a control in the design host.</para> + <para>The <see cref="P:System.Web.UI.Design.DesignerRegionMouseEventArgs.Region" /> property represents the control designer region that the event applies to, if any. The <see cref="P:System.Web.UI.Design.DesignerRegionMouseEventArgs.Location" /> property represents the location on the design surface that was clicked.</para> + <para>For more information about events and delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for a <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event that is raised when you click on a selected control or a designer region in a selected control. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +35,19 @@ <Parameter Name="location" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <param name="location">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> delegate method uses the <see cref="M:System.Web.UI.Design.DesignerRegionMouseEventArgs.#ctor(System.Web.UI.Design.DesignerRegion,System.Drawing.Point)" /> constructor to initialize a <see cref="T:System.Web.UI.Design.DesignerRegionMouseEventArgs" /> object for use with a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object.</para> + <para>When you click a control region at design time, the designer host initializes a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object for a <see cref="F:System.Web.UI.Design.ViewEvent.Click" /> event type, and then sets the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property with a <see cref="T:System.Web.UI.Design.DesignerRegionMouseEventArgs" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerRegionMouseEventArgs" /> class with the specified region and location. </para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The designer region that was clicked; used to initialize the <see cref="P:System.Web.UI.Design.DesignerRegionMouseEventArgs.Region" />.</param> + <param name="location"> + <attribution license="cc4" from="Microsoft" modified="false" />The location that was clicked, relative to the upper left corner of the region; used to initialize the <see cref="P:System.Web.UI.Design.DesignerRegionMouseEventArgs.Location" />.</param> </Docs> </Member> <Member MemberName="Location"> @@ -40,9 +60,16 @@ <ReturnType>System.Drawing.Point</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DesignerRegionMouseEventArgs.Location" /> property contains the coordinates that identify where you clicked, relative to the upper left corner of the region.</para> + <para>The <see cref="P:System.Web.UI.Design.DesignerRegionMouseEventArgs.Location" /> property is initialized by the <see cref="M:System.Web.UI.Design.DesignerRegionMouseEventArgs.#ctor(System.Web.UI.Design.DesignerRegion,System.Drawing.Point)" /> constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the location within the control that was clicked.</para> + </summary> </Docs> </Member> <Member MemberName="Region"> @@ -55,10 +82,17 @@ <ReturnType>System.Web.UI.Design.DesignerRegion</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.DesignerRegionMouseEventArgs.Region" /> property represents the control designer region that was clicked, if any.</para> + <para>The <see cref="P:System.Web.UI.Design.DesignerRegionMouseEventArgs.Region" /> property is initialized by the <see cref="M:System.Web.UI.Design.DesignerRegionMouseEventArgs.#ctor(System.Web.UI.Design.DesignerRegion,System.Drawing.Point)" /> constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the designer region that was clicked, if any.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/EditableDesignerRegion.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/EditableDesignerRegion.xml index 0c870a8d3d7..f98282f46af 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/EditableDesignerRegion.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/EditableDesignerRegion.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="EditableDesignerRegion" FullName="System.Web.UI.Design.EditableDesignerRegion"> <TypeSignature Language="C#" Value="public class EditableDesignerRegion : System.Web.UI.Design.DesignerRegion" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> class to help manage templates at design time. A <see cref="T:System.Web.UI.Design.ControlDesigner" /> will use an instance of this class with its <see cref="M:System.Web.UI.Design.ControlDesigner.GetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion)" /> method to generate HTML markup of the region's content.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents an editable content region within the design-time markup for the associated control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +31,15 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="name">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> class using the given owner and name.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ControlDesigner" /> object, or a designer that derives from <see cref="T:System.Web.UI.Design.ControlDesigner" />.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the region.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -42,11 +54,17 @@ <Parameter Name="serverControlsOnly" Type="System.Boolean" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="name">To be added.</param> - <param name="serverControlsOnly">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new instance of the <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> class using the given owner and name and the initial value of the <see cref="P:System.Web.UI.Design.EditableDesignerRegion.ServerControlsOnly" /> property.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ControlDesigner" /> object, or a designer that derives from <see cref="T:System.Web.UI.Design.ControlDesigner" />.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the region.</param> + <param name="serverControlsOnly"> + <attribution license="cc4" from="Microsoft" modified="false" />true to have the region accept only Web server controls for content; otherwise, false.</param> </Docs> </Member> <Member MemberName="Content"> @@ -59,9 +77,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the HTML markup for the content of the region.</para> + </summary> </Docs> </Member> <Member MemberName="GetChildViewRendering"> @@ -77,10 +98,14 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a <see cref="T:System.Web.UI.Design.ViewRendering" /> object containing the design-time HTML markup for the given control.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The control for which to get the <see cref="T:System.Web.UI.Design.ViewRendering" /> object for the current region.</param> </Docs> </Member> <Member MemberName="ServerControlsOnly"> @@ -93,9 +118,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 the region can accept only Web server controls.</para> + </summary> </Docs> </Member> <Member MemberName="SupportsDataBinding"> @@ -108,10 +136,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 the region can be bound to a data source.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionEditor.xml index 6ddf4092ac2..d9bd5fa8522 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ExpressionEditor" FullName="System.Web.UI.Design.ExpressionEditor"> <TypeSignature Language="C#" Value="public abstract class ExpressionEditor" /> <AssemblyInfo> @@ -9,9 +10,19 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A visual designer host, such as vsprvslong, uses the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class to present custom expression editor sheets to the user, and then evaluate the selected expression for design-time rendering.</para> + <para>When you browse the <see cref="P:System.Web.UI.Design.HtmlControlDesigner.Expressions" /> property for a control in the design-time Properties grid, the visual designer displays a dialog box to set expressions for a control property. You can select the expression type based on a list of expression prefixes. When you select an expression prefix from the list, the visual designer uses the associated <see cref="T:System.Web.UI.Design.ExpressionEditor" /> and <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> objects to set, evaluate, and convert the expression string based on the syntax for that type of expression. The visual designer sets the expression for the associated control property, and then uses the evaluated expression result to assign control property values that are rendered on the design surface.</para> + <para>The static <see cref="Overload:System.Web.UI.Design.ExpressionEditor.GetExpressionEditor" /> methods get the expression editor that is associated with a particular expression prefix or expression builder. The <see cref="P:System.Web.UI.Design.ExpressionEditor.ExpressionPrefix" /> property for an <see cref="T:System.Web.UI.Design.ExpressionEditor" /> object returns the configured expression prefix. The <see cref="M:System.Web.UI.Design.ExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method evaluates an input expression string. The <see cref="M:System.Web.UI.Design.ExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns the <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> implementation that is used to prompt for the custom expression properties in the expressions dialog box.</para> + <para>Typically, to support a new expression type at design time, you define a unique expression prefix and provide custom <see cref="T:System.Web.Compilation.ExpressionBuilder" /> and <see cref="T:System.Web.UI.Design.ExpressionEditor" /> implementations. Optionally, you can provide a custom <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> implementation that defines properties that are used to form the expression in the expressions dialog box. </para> + <para>The expression prefix identifies the custom expression type and associates an expression with the expression builder and expression editor. When custom expressions are parsed in a page, the expression prefix is used to create instances of the associated <see cref="T:System.Web.Compilation.ExpressionBuilder" /> and <see cref="T:System.Web.UI.Design.ExpressionEditor" /> classes. To associate an expression prefix with an expression builder and expression editor, apply the <see cref="T:System.Web.Compilation.ExpressionEditorAttribute" /> and <see cref="T:System.Web.Compilation.ExpressionPrefixAttribute" /> attributes to the custom <see cref="T:System.Web.Compilation.ExpressionBuilder" /> class and configure the expression prefix for an expression builder in the expressionBuilders element in the Web configuration file. The prefix is not required, but highly recommended.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines a set of properties and methods for evaluating an expression that is associated with a control property at design time and to provide an expression editor sheet to the visual design host for use in the expression editor dialog box. This class is abstract.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +30,15 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Because the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class is abstract, you cannot create an instance of the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class directly using the <see cref="M:System.Web.UI.Design.ExpressionEditor.#ctor" /> constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -40,14 +57,25 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="parseTimeData">To be added.</param> - <param name="propertyType">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The visual designer host uses the <see cref="M:System.Web.UI.Design.ExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method to evaluate an expression and provide the design-time value for an associated control property. </para> + <para>The visual designer uses the <see cref="M:System.Web.Compilation.ExpressionBuilder.ParseExpression(System.String,System.Type,System.Web.Compilation.ExpressionBuilderContext)" /> method to parse the expression string at design time, and then calls the <see cref="M:System.Web.UI.Design.ExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method with the parsed expression data. The visual designer uses the evaluated expression result to assign control property values that are rendered on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Evaluates an expression string and provides the design-time value for a control property.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />An expression string to evaluate. The expression does not include the expression prefix.</param> + <param name="parseTimeData"> + <attribution license="cc4" from="Microsoft" modified="false" />An object containing additional parsing information for evaluating <paramref name="expression" />. This typically is provided by the expression builder.</param> + <param name="propertyType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the control property to which <paramref name="expression" /> is bound.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -60,10 +88,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The expression prefix identifies the custom expression type and associates an expression with the expression builder and expression editor. When custom expressions are parsed in a page, the expression prefix is used to create instances of the associated <see cref="T:System.Web.Compilation.ExpressionBuilder" /> and <see cref="T:System.Web.UI.Design.ExpressionEditor" /> classes. To associate an expression prefix with an expression builder and expression editor, apply the <see cref="T:System.Web.Compilation.ExpressionEditorAttribute" /> and <see cref="T:System.Web.Compilation.ExpressionPrefixAttribute" /> attributes to the custom <see cref="T:System.Web.Compilation.ExpressionBuilder" /> class and configure the expression prefix for an expression builder in the expressionBuilders element in the Web configuration file.</para> + <para>Typically, derived classes do not override the <see cref="P:System.Web.UI.Design.ExpressionEditor.ExpressionPrefix" /> property. The base <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class sets the <see cref="P:System.Web.UI.Design.ExpressionEditor.ExpressionPrefix" /> value based on the <see cref="T:System.Web.Compilation.ExpressionPrefixAttribute" /> attribute for the associated <see cref="T:System.Web.Compilation.ExpressionBuilder" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the expression prefix that identifies expression strings that are supported by the expression editor implementation.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -80,12 +115,23 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expressionPrefix">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the static <see cref="Overload:System.Web.UI.Design.ExpressionEditor.GetExpressionEditor" /> method overloads to find the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> object that is associated with a particular expression prefix or expression builder type.</para> + <para>For each custom expression type, an expression prefix identifies the associated expression builder and expression editor. When custom expressions are parsed in a page, the expression prefix is used to create instances of the associated <see cref="T:System.Web.Compilation.ExpressionBuilder" /> and <see cref="T:System.Web.UI.Design.ExpressionEditor" /> classes. </para> + <para>To associate an expression prefix with an expression builder and expression editor, apply the <see cref="T:System.Web.Compilation.ExpressionEditorAttribute" /> and <see cref="T:System.Web.Compilation.ExpressionPrefixAttribute" /> attributes to the custom <see cref="T:System.Web.Compilation.ExpressionBuilder" /> class and configure the expression prefix for an expression builder in the expressionBuilders element in the Web configuration file.</para> + <para>To find the associated expression editor for an expression prefix, the <see cref="Overload:System.Web.UI.Design.ExpressionEditor.GetExpressionEditor" /> method enumerates the available <see cref="T:System.Web.Compilation.ExpressionBuilder" /> implementations for a matching prefix. The <see cref="T:System.Web.Compilation.ExpressionBuilder" /> implementations can be configured in the expressionBuilders section of the Web configuration file. If an available <see cref="T:System.Web.Compilation.ExpressionBuilder" /> implementation defines the expression prefix, the <see cref="Overload:System.Web.UI.Design.ExpressionEditor.GetExpressionEditor" /> method returns the type that is specified in the <see cref="T:System.Web.Compilation.ExpressionEditorAttribute" /> attribute of the <see cref="T:System.Web.Compilation.ExpressionBuilder" /> metadata.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an <see cref="T:System.Web.UI.Design.ExpressionEditor" /> implementation that is associated with the specified expression prefix.</para> + </summary> + <param name="expressionPrefix"> + <attribution license="cc4" from="Microsoft" modified="false" />The expression prefix used to find the associated expression editor.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -102,12 +148,23 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expressionBuilderType">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the static <see cref="Overload:System.Web.UI.Design.ExpressionEditor.GetExpressionEditor" /> overloads to find the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> object that is associated with a particular expression prefix or expression builder type.</para> + <para>For each custom expression type, an expression prefix identifies the associated expression builder and expression editor. When custom expressions are parsed in a page, the expression prefix is used to create instances of the associated <see cref="T:System.Web.Compilation.ExpressionBuilder" /> and <see cref="T:System.Web.UI.Design.ExpressionEditor" /> classes. </para> + <para>To associate an expression prefix with an expression builder and expression editor, apply the <see cref="T:System.Web.Compilation.ExpressionEditorAttribute" /> and <see cref="T:System.Web.Compilation.ExpressionPrefixAttribute" /> attributes to the custom <see cref="T:System.Web.Compilation.ExpressionBuilder" /> class and configure the expression prefix for an expression builder in the expressionBuilders element in the Web configuration file.</para> + <para>The <see cref="Overload:System.Web.UI.Design.ExpressionEditor.GetExpressionEditor" /> method enumerates the available <see cref="T:System.Web.Compilation.ExpressionBuilder" /> implementations to locate <paramref name="expressionBuilderType" />. The <see cref="T:System.Web.Compilation.ExpressionBuilder" /> implementations can be configured in the expressionBuilders section of the Web configuration file. If <paramref name="expressionBuilderType" /> is found in the set of available <see cref="T:System.Web.Compilation.ExpressionBuilder" /> implementations, the <see cref="Overload:System.Web.UI.Design.ExpressionEditor.GetExpressionEditor" /> method returns the type that is specified in the <see cref="T:System.Web.Compilation.ExpressionEditorAttribute" /> attribute of the <see cref="T:System.Web.Compilation.ExpressionBuilder" /> metadata.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an <see cref="T:System.Web.UI.Design.ExpressionEditor" /> implementation that is associated with the specified expression builder type.</para> + </summary> + <param name="expressionBuilderType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the derived expression builder class, used to locate the associated expression editor.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -124,16 +181,26 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns an <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> implementation that defines the strings that are combined to form a custom expression. The visual designer uses an expression editor sheet to prompt for one or more strings that combine into a custom expression. The base class method returns a default expression editor sheet, which uses a single input string to form the expression. The expression editor sheet defines the property grid for the expression. Therefore, the properties that the expression editor exposes become properties that can be defined for the expression in the dialog box.</para> + <para>Classes deriving from the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class optionally can override the <see cref="M:System.Web.UI.Design.ExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method to provide a custom expression editor sheet. A custom expression editor sheet can allow design-time input for multiple properties, which are combined together to form the expression string. </para> + <para>For example, the <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> class derives from the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class and provides an implementation for evaluating and associating a resource string reference with a control property at design time. The <see cref="T:System.Web.Compilation.ResourceExpressionBuilder" /> class is associated with the expression prefix Resources and the <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> implementation. The <see cref="M:System.Web.UI.Design.ResourceExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns a <see cref="T:System.Web.UI.Design.ResourceExpressionEditorSheet" />, which defines the individual properties that form a resource reference expression.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an expression editor sheet that is associated with the current expression editor.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />The expression string set for a control property, used to initialize the expression editor sheet.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionEditorSheet.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionEditorSheet.xml index c90780ab4cd..8c34c42a356 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionEditorSheet.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionEditorSheet.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ExpressionEditorSheet" FullName="System.Web.UI.Design.ExpressionEditorSheet"> <TypeSignature Language="C#" Value="public abstract class ExpressionEditorSheet" /> <AssemblyInfo> @@ -9,9 +10,28 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A custom expression editor sheet lets a developer set properties on a custom expression at design-time. Control property values can be set using expression strings; the expression strings are evaluated at run time by an expression builder and at design time by an expression editor.</para> + <para>When you browse the <see cref="P:System.Web.UI.Design.HtmlControlDesigner.Expressions" /> property for a control in the design-time properties grid, the visual designer displays a dialog box to set expressions that provide the value for a control property. You can select the expression type based on a list of expression prefixes. When you select an expression prefix from the list, the visual designer uses the associated <see cref="T:System.Web.UI.Design.ExpressionEditor" /> and <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> objects to evaluate and convert the expression string based on the syntax for that type of expression. The visual designer uses expression editor sheet properties to prompt for one or more strings that combine into the custom expression string. </para> + <para>Typically, to supply a new expression type at design time, you define a unique expression prefix and provide custom <see cref="T:System.Web.Compilation.ExpressionBuilder" /> and <see cref="T:System.Web.UI.Design.ExpressionEditor" /> implementations. Optionally, you can provide a custom <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> implementation that defines properties that are used to form the expression. To associate an expression prefix with an expression builder and an expression editor, apply the <see cref="T:System.Web.Compilation.ExpressionEditorAttribute" /> attribute and an <see cref="T:System.Web.Compilation.ExpressionPrefixAttribute" /> attribute to the custom <see cref="T:System.Web.Configuration.ExpressionBuilder" /> class, and then configure the expression prefix for an expression builder in the expressionBuilders element in the Web configuration file.</para> + <para>The default implementation of the <see cref="M:System.Web.UI.Design.ExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns a basic editor sheet, which uses a single input string to form the expression. Custom expression editors that are derived from the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> can override the <see cref="M:System.Web.UI.Design.ExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method to return a custom editor sheet implementation. Typically, a custom editor sheet contains multiple properties that are used to build the expression string. The <see cref="M:System.Web.UI.Design.ExpressionEditorSheet.GetExpression" /> method returns the resulting expression string based on the current expression properties.</para> + <para>For example, the <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> class derives from the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class and provides an implementation for evaluating and associating a resource string reference with a control property at design time. The <see cref="T:System.Web.Compilation.ResourceExpressionBuilder" /> class is associated with the expression prefix Resources and the <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> implementation. The <see cref="M:System.Web.UI.Design.ResourceExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns a <see cref="T:System.Web.UI.Design.ResourceExpressionEditorSheet" />, which defines the individual properties that form a resource reference expression.</para> + <para>When you inherit from the <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> class, you must override the following members: </para> + <list type="bullet"> + <item> + <para>The <see cref="M:System.Web.UI.Design.ExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method to return a custom editor sheet implementation. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.ExpressionEditorSheet.#ctor(System.IServiceProvider)" /> constructor to implement custom initialization actions for your expression editor sheet implementation.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a design-time editor sheet for a custom expression. This class must be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,10 +41,17 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Because the <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> class is abstract, you cannot create an instance of an <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> directly using the <see cref="M:System.Web.UI.Design.ExpressionEditorSheet.#ctor(System.IServiceProvider)" /> constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> class.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -38,10 +65,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A custom expression editor sheet contains design-time settings for multiple expression properties, which are combined to form an expression string. Control property values can be set using expression strings; the expression strings are evaluated at run time by an expression builder.</para> + <para>The <see cref="M:System.Web.UI.Design.ExpressionEditorSheet.GetExpression" /> method returns an expression string that is built from the current expression properties. The visual designer allows you to set the expression sheet properties, and then calls the <see cref="M:System.Web.UI.Design.ExpressionEditorSheet.GetExpression" /> method to get the expression string and set the control property value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, returns the expression string that is formed by the expression editor sheet property values.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -54,10 +88,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This base implementation always returns true.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the expression string is valid.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -80,14 +120,21 @@ <ReturnType>System.IServiceProvider</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.ExpressionEditorSheet.#ctor(System.IServiceProvider)" /> constructor to set the <see cref="P:System.Web.UI.Design.ExpressionEditorSheet.ServiceProvider" /> implementation for a custom expression editor sheet.</para> + <para>The <see cref="P:System.Web.UI.Design.ExpressionEditorSheet.ServiceProvider" /> property can be used to access services that are provided by the designer host. For example, call the <see cref="M:System.IServiceProvider.GetService(System.Type)" /> method with the <see cref="T:System.Web.UI.Design.IWebApplication" /> interface to access project items, documents, or configuration file details that are provided through the visual designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the service provider implementation that is used by the expression editor sheet.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionsCollectionConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionsCollectionConverter.xml index 3e22bb02bfc..de20065b1fe 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionsCollectionConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionsCollectionConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ExpressionsCollectionConverter" FullName="System.Web.UI.Design.ExpressionsCollectionConverter"> <TypeSignature Language="C#" Value="public class ExpressionsCollectionConverter : System.ComponentModel.TypeConverter" /> <AssemblyInfo> @@ -9,8 +10,18 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ExpressionsCollectionConverter" /> class converts an <see cref="T:System.Web.UI.ExpressionBindingCollection" /> to a string for the property-editing grid at design time, which always appears as an empty string ("").</para> + <para>A designer host, such as vsprvslong, uses the <see cref="T:System.Web.Compilation.ExpressionBuilder" /> and <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class implementations with the <see cref="T:System.Web.UI.Design.ExpressionsCollectionEditor" /> and <see cref="T:System.Web.UI.Design.ExpressionsCollectionConverter" /> classes to set the expression bindings for control properties at design time, and the <see cref="T:System.Web.UI.Design.ControlPersister" /> to persist the expressions for run time. Expression strings reference a localizable resource, an application setting, a connection string, or a custom expression type. The expression string is bound to the control property at design time, and then used at run time to determine the value for the property. </para> + <block subset="none" type="note"> + <para>You should never access a type converter directly. This implementation of <see cref="T:System.ComponentModel.TypeConverter" /> is intended only for use by an <see cref="T:System.Web.UI.ExpressionBindingCollection" /> object at design time.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type converter for expression binding collections.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +32,16 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>You should never access a type converter directly. This implementation of <see cref="T:System.ComponentModel.TypeConverter" /> is intended only for use by an <see cref="T:System.Web.UI.ExpressionBindingCollection" /> object at design time.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ExpressionsCollectionConverter" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="ConvertTo"> @@ -41,14 +60,26 @@ <Parameter Name="destinationType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <param name="destinationType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>You should never access a type converter directly. This implementation of <see cref="T:System.ComponentModel.TypeConverter" /> is intended only for use by an <see cref="T:System.Web.UI.ExpressionBindingCollection" /> object at design time.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts an expression binding collection to the specified type.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that indicates the component or control the expression binding collection belongs to. </param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Globalization.CultureInfo" /> object that can be used to provide additional culture information.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to convert. </param> + <param name="destinationType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type to convert to.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionsCollectionEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionsCollectionEditor.xml index eab946c25b4..279853aacda 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionsCollectionEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ExpressionsCollectionEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ExpressionsCollectionEditor" FullName="System.Web.UI.Design.ExpressionsCollectionEditor"> <TypeSignature Language="C#" Value="public class ExpressionsCollectionEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An instance of the <see cref="T:System.Web.UI.Design.ExpressionsCollectionEditor" /> class is a <see cref="T:System.Drawing.Design.UITypeEditor" /> object that can be used at design time to select and edit a collection of expression bindings, and assign the expressions to a control property.</para> + <para>A designer host, such as vsprvslong, uses the <see cref="T:System.Web.Compilation.ExpressionBuilder" /> and <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class implementations with the <see cref="T:System.Web.UI.Design.ExpressionsCollectionEditor" />Â and <see cref="T:System.Web.UI.Design.ExpressionsCollectionConverter" />Â classes to set the expression bindings for control properties at design time, and the <see cref="T:System.Web.UI.Design.ControlPersister" />Â class to persist the expressions for run time. Expression strings reference a localizable resource, an application setting, a connection string, or a custom expression type. The expression string is bound to the control property at design time, and then used at run time to determine the value for the property. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for selecting and editing an expressions binding collection at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +29,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ExpressionsCollectionEditor" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="EditValue"> @@ -40,12 +51,23 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.Web.UI.Design.ExpressionsCollectionEditor.EditValue" /> method launches the user interface for editing the <paramref name="value" /> object. The designer host calls the <see cref="Overload:System.Web.UI.Design.ExpressionsCollectionEditor.EditValue" /> method when you attempt to edit the value of a property that this editor is associated with. The input service provider is used to obtain any editing services that are required within the <see cref="Overload:System.Web.UI.Design.ExpressionsCollectionEditor.EditValue" />.</para> + <para>A designer host, such as vsprvslong, uses the <see cref="T:System.Web.Compilation.ExpressionBuilder" /> and <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class implementations with the <see cref="T:System.Web.UI.Design.ExpressionsCollectionEditor" /> and <see cref="T:System.Web.UI.Design.ExpressionsCollectionConverter" /> classes to set the expression bindings for control properties at design time, and the <see cref="T:System.Web.UI.Design.ControlPersister" />Â class to persist the expressions for run time. Expression strings reference a localizable resource, an application setting, a connection string, or a custom expression type. The expression string is bound to the control property at design time, and then used at run time to determine the value for the property. </para> + <para>If users cancel the user interface without modifying the expression binding collection, the <see cref="Overload:System.Web.UI.Design.ExpressionsCollectionEditor.EditValue" /> method returns the input <paramref name="value" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the specified object with the specified service provider and context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information such as the associated control.</param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which editing services can be obtained.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the object being edited.</param> </Docs> </Member> <Member MemberName="GetEditStyle"> @@ -61,11 +83,19 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.Web.UI.Design.ExpressionsCollectionEditor.GetEditStyle" /> method returns the <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.Modal" /> value by default. </para> + <para>If <see cref="Overload:System.Web.UI.Design.ExpressionsCollectionEditor.GetEditStyle" /> is not supported in the specified context, the <see cref="Overload:System.Web.UI.Design.ExpressionsCollectionEditor.GetEditStyle" /> returns <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editing style that is associated with this editor for the specified context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HierarchicalDataSourceConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HierarchicalDataSourceConverter.xml index 45b197653d9..ce58b096ba5 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HierarchicalDataSourceConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HierarchicalDataSourceConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="HierarchicalDataSourceConverter" FullName="System.Web.UI.Design.HierarchicalDataSourceConverter"> <TypeSignature Language="C#" Value="public class HierarchicalDataSourceConverter : System.Web.UI.Design.DataSourceConverter" /> <AssemblyInfo> @@ -9,8 +10,19 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.HierarchicalDataSourceConverter" /> class provides methods that can be used to retrieve a list of the hierarchical data sources that are accessible to the current design-time component.</para> + <para>The <see cref="T:System.Web.UI.Design.HierarchicalDataSourceConverter" /> type converter is used by Microsoft Visual Studio to provide the values that appear in the list of data sources in the <ui>Properties</ui> window.</para> + <block subset="none" type="note"> + <para>You should never access a type converter directly. Instead, call the appropriate converter by using the <see cref="T:System.ComponentModel.TypeDescriptor" /> class. For more information, see the examples in <see cref="T:System.ComponentModel.TypeConverter" />.</para> + </block> + <para>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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a type converter that can retrieve a list of the hierarchical data sources that are accessible to the current component.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +33,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.HierarchicalDataSourceConverter" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="IsValidDataSource"> @@ -38,11 +53,18 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.DataSourceConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method uses the <see cref="M:System.Web.UI.Design.HierarchicalDataSourceConverter.IsValidDataSource(System.ComponentModel.IComponent)" /> method to determine which components are available as standard accessible data sources. For the <see cref="T:System.Web.UI.Design.HierarchicalDataSourceConverter" /> class, a valid data source is a component that implements the <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> interface. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the specified component is a valid data source for this converter.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to check as a valid data source.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HierarchicalDataSourceDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HierarchicalDataSourceDesigner.xml index 14db2f5d3ea..44e0306d057 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HierarchicalDataSourceDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HierarchicalDataSourceDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="HierarchicalDataSourceDesigner" FullName="System.Web.UI.Design.HierarchicalDataSourceDesigner"> <TypeSignature Language="C#" Value="public class HierarchicalDataSourceDesigner : System.Web.UI.Design.ControlDesigner, System.Web.UI.Design.IHierarchicalDataSourceDesigner" /> <AssemblyInfo> @@ -13,8 +14,14 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a visual designer for the <see cref="T:System.Web.UI.HierarchicalDataSourceControl" /> control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,8 +32,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.HierarchicalDataSourceDesigner" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="ActionLists"> @@ -39,9 +49,12 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the action list collection for the control designer.</para> + </summary> </Docs> </Member> <Member MemberName="CanConfigure"> @@ -54,9 +67,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the <see cref="M:System.Web.UI.Design.IHierarchicalDataSourceDesigner.Configure" /> method can be called.</para> + </summary> </Docs> </Member> <Member MemberName="CanRefreshSchema"> @@ -69,9 +88,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the <see cref="M:System.Web.UI.Design.IHierarchicalDataSourceDesigner.RefreshSchema(System.Boolean)" /> method can be called.</para> + </summary> </Docs> </Member> <Member MemberName="Configure"> @@ -85,8 +110,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Launches the configuration wizard for the underlying data source.</para> + </summary> </Docs> </Member> <Member MemberName="DataSourceChanged"> @@ -99,8 +130,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when any property of the associated data source changes.</para> + </summary> </Docs> </Member> <Member MemberName="GetDesignTimeHtml"> @@ -114,9 +148,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the HTML markup that is used to represent the control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="GetView"> @@ -132,10 +169,14 @@ <Parameter Name="viewPath" Type="System.String" /> </Parameters> <Docs> - <param name="viewPath">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the named data source view associated with the data source control.</para> + </summary> + <param name="viewPath"> + <attribution license="cc4" from="Microsoft" modified="false" />The unique path to the block of data to use in creating the view.</param> </Docs> </Member> <Member MemberName="OnDataSourceChanged"> @@ -151,9 +192,16 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object provided by the calling object.</param> </Docs> </Member> <Member MemberName="OnSchemaRefreshed"> @@ -169,9 +217,16 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object.</param> </Docs> </Member> <Member MemberName="RefreshSchema"> @@ -187,9 +242,16 @@ <Parameter Name="preferSilent" Type="System.Boolean" /> </Parameters> <Docs> - <param name="preferSilent">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Refreshes the schema of the data.</para> + </summary> + <param name="preferSilent"> + <attribution license="cc4" from="Microsoft" modified="false" />This parameter is not used in this implementation. However, it should be supported in derived classes.</param> </Docs> </Member> <Member MemberName="ResumeDataSourceEvents"> @@ -203,8 +265,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Restores data source events after they have been suppressed.</para> + </summary> </Docs> </Member> <Member MemberName="SchemaRefreshed"> @@ -217,8 +285,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs after the schema has been refreshed.</para> + </summary> </Docs> </Member> <Member MemberName="SuppressDataSourceEvents"> @@ -232,8 +303,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Postpones all data source events until after the <see cref="M:System.Web.UI.Design.HierarchicalDataSourceDesigner.ResumeDataSourceEvents" /> method is called.</para> + </summary> </Docs> </Member> <Member MemberName="SuppressingDataSourceEvents"> @@ -246,10 +320,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether data source events have been disabled.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HtmlControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HtmlControlDesigner.xml index e0abd452709..4893b5c37e3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HtmlControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HtmlControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="HtmlControlDesigner" FullName="System.Web.UI.Design.HtmlControlDesigner"> <TypeSignature Language="C#" Value="public class HtmlControlDesigner : System.ComponentModel.Design.ComponentDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides basic design-time functionality for ASP.NET server controls.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.HtmlControlDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +41,17 @@ <ReturnType>System.Web.UI.Design.IHtmlControlDesignerBehavior</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="P:System.Web.UI.Design.HtmlControlDesigner.Behavior" /> property is obsolete. Use the <see cref="M:System.Web.UI.Design.IControlDesignerTag.SetAttribute(System.String,System.String)" /> and <see cref="M:System.Web.UI.Design.IControlDesignerTag.GetAttribute(System.String)" /> methods on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property to map properties to styles. Use the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeCssAttributes" /> method on the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class to set styles for the control at design time.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the DHTML behavior that is associated with the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -55,9 +70,12 @@ <ReturnType>System.Web.UI.DataBindingCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data bindings collection for the current control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -71,9 +89,15 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.HtmlControlDesigner.DesignTimeElement" /> property is used by the designer to retrieve the design-time object representing the control that is associated with the <see cref="T:System.Web.UI.Design.HtmlControlDesigner" /> object on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design-time object representing the control that is associated with the <see cref="T:System.Web.UI.Design.HtmlControlDesigner" /> object on the design surface.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -95,9 +119,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.Web.UI.Design.HtmlControlDesigner" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources that are used by the <see cref="T:System.Web.UI.Design.HtmlControlDesigner" /> object and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -114,9 +146,16 @@ <ReturnType>System.Web.UI.ExpressionBindingCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The design host, such as vsprvslong, uses the <see cref="T:System.Web.Compilation.ExpressionBuilder" /> class to get the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class to get the <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> to set expressions for control properties at design time. Expression strings reference a localizable resource, an application setting, a connection string, or a custom expression type.</para> + <para>The <see cref="P:System.Web.UI.Design.HtmlControlDesigner.Expressions" /> collection contains an <see cref="T:System.Web.UI.ExpressionBinding" /> element for each control property that has an associated expression string. Each <see cref="P:System.Web.UI.ExpressionBinding.ExpressionPrefix" /> property for each element indicates the associated expression builder implementation. The expression string is parsed and evaluated by its associated <see cref="T:System.Web.Compilation.ExpressionBuilder" /> to determine the control property value at run time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the expression bindings for the current control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="Initialize"> @@ -132,9 +171,16 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ControlDesigner.Initialize(System.ComponentModel.IComponent)" /> method should be called by the designer host to initialize the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer and sets the component for design.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The control element for design. </param> </Docs> </Member> <Member MemberName="OnBehaviorAttached"> @@ -145,8 +191,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.HtmlControlDesigner.OnBehaviorAttached" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.IControlDesignerTag.SetAttribute(System.String,System.String)" /> and <see cref="M:System.Web.UI.Design.IControlDesignerTag.GetAttribute(System.String)" /> methods on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property to map properties to styles. Use the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeCssAttributes" /> method on the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class to set styles for the control at design time. Override the <see cref="M:System.Web.UI.Design.HtmlControlDesigner.Initialize(System.ComponentModel.IComponent)" /> method to manipulate the initial styles for the control at design time.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when a behavior is associated with the element.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -166,8 +220,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.HtmlControlDesigner.OnBehaviorDetaching" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.IControlDesignerTag.SetAttribute(System.String,System.String)" /> and <see cref="M:System.Web.UI.Design.IControlDesignerTag.GetAttribute(System.String)" /> methods on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property to map properties to styles. Use the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeCssAttributes" /> method on the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class to set styles for the control at design time. Override the <see cref="Overload:System.Web.UI.Design.HtmlControlDesigner.Dispose" /> method for the control designer to perform actions before the designer object is released.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when a behavior disassociates from the element.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -189,9 +251,19 @@ <Parameter Name="propName" Type="System.String" /> </Parameters> <Docs> - <param name="propName">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.HtmlControlDesigner.OnBindingsCollectionChanged(System.String)" /> method should be called by a control designer after the control designer has made a change to the data bindings for the control.</para> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.HtmlControlDesigner.OnBindingsCollectionChanged(System.String)" /> method is obsolete. Use the <see cref="E:System.Web.UI.DataBindingCollection.Changed" /> event on the <see cref="P:System.Web.UI.Design.HtmlControlDesigner.DataBindings" /> collection for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a method that can be used to indicate when a data binding has changed.</para> + </summary> + <param name="propName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the property that has changed. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -211,8 +283,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a way to perform additional processing when the associated control is attached to a parent control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -229,9 +304,17 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.HtmlControlDesigner.PreFilterEvents(System.Collections.IDictionary)" /> method provides a way to add items to or remove items from the dictionary of events that a designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + <para>The keys in the dictionary of events are the names of the events. The objects are of type <see cref="T:System.ComponentModel.PropertyDescriptor" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the list of events that are exposed at design-time for the <see cref="T:System.ComponentModel.TypeDescriptor" /> object for the component.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the names of the events of the component to expose. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -248,9 +331,17 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.HtmlControlDesigner.PreFilterProperties(System.Collections.IDictionary)" /> method provides a way to add items to or remove items from the dictionary of properties that a designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + <para>The keys in the dictionary of properties are the names of the properties. The objects are of type <see cref="T:System.ComponentModel.PropertyDescriptor" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows the designer to expose a specific set of properties through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object at design time.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The set of properties to filter for the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -264,9 +355,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 to create a field declaration for the control in the code-behind file for the current design document during serialization.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -279,4 +373,4 @@ </Attributes> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HtmlIntrinsicControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HtmlIntrinsicControlDesigner.xml index 6d02f341783..0afe65be6ba 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HtmlIntrinsicControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HtmlIntrinsicControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="HtmlIntrinsicControlDesigner" FullName="System.Web.UI.Design.HtmlIntrinsicControlDesigner"> <TypeSignature Language="C#" Value="public class HtmlIntrinsicControlDesigner : System.Web.UI.Design.HtmlControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Intrinsic HTML controls are defined within, or derived from classes defined within, the <see cref="N:System.Web.UI.HtmlControls" /> namespace.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base designer for all intrinsic HTML controls.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes an instance of the <see cref="T:System.Web.UI.Design.HtmlIntrinsicControlDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -28,4 +38,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HyperLinkDataBindingHandler.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HyperLinkDataBindingHandler.xml index 64625365dd8..3d72cd657ca 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HyperLinkDataBindingHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/HyperLinkDataBindingHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="HyperLinkDataBindingHandler" FullName="System.Web.UI.Design.HyperLinkDataBindingHandler"> <TypeSignature Language="C#" Value="public class HyperLinkDataBindingHandler : System.Web.UI.Design.DataBindingHandler" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a data-binding handler for a hyperlink property.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes an instance of the <see cref="T:System.Web.UI.Design.HyperLinkDataBindingHandler" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,10 +45,18 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <param name="control">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method determines whether the <see cref="P:System.Web.UI.WebControls.HyperLink.Text" /> and <see cref="P:System.Web.UI.WebControls.HyperLink.NavigateUrl" /> properties of the <see cref="T:System.Web.UI.WebControls.HyperLink" /> control are data-bound. If the <see cref="P:System.Web.UI.WebControls.HyperLink.Text" /> property is data-bound, this method sets the value of the property to "DataBound". If the <see cref="P:System.Web.UI.WebControls.HyperLink.NavigateUrl" /> property is data-bound, this method sets the value of the property to a text string so the control will have the appearance of a working hyperlink.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Resolves design-time data-binding for the specified control.</para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.IDesignerHost" /> for the document that contains the control. </param> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> to data bind. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -49,4 +64,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IContentResolutionService.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IContentResolutionService.xml index f765d025890..79c9f92d73c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IContentResolutionService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IContentResolutionService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IContentResolutionService" FullName="System.Web.UI.Design.IContentResolutionService"> <TypeSignature Language="C#" Value="public interface IContentResolutionService" /> <AssemblyInfo> @@ -6,8 +7,11 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for access to a master page from a content page at design time, if provided by a design host, such as vsprvslong. </para> + </summary> </Docs> <Members> <Member MemberName="ContentDefinitions"> @@ -20,9 +24,12 @@ <ReturnType>System.Collections.IDictionary</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Web.UI.Design.ContentDefinition" /> objects for the content placeholders that are identified in the master page.</para> + </summary> </Docs> </Member> <Member MemberName="GetContentDesignerState"> @@ -38,10 +45,14 @@ <Parameter Name="identifier" Type="System.String" /> </Parameters> <Docs> - <param name="identifier">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the current state of the identified content place holder.</para> + </summary> + <param name="identifier"> + <attribution license="cc4" from="Microsoft" modified="false" />The identifier for a content place holder.</param> </Docs> </Member> <Member MemberName="SetContentDesignerState"> @@ -58,11 +69,16 @@ <Parameter Name="state" Type="System.Web.UI.Design.ContentDesignerState" /> </Parameters> <Docs> - <param name="identifier">To be added.</param> - <param name="state">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the current state of the identified content place holder.</para> + </summary> + <param name="identifier"> + <attribution license="cc4" from="Microsoft" modified="false" />The identifier for a content place holder.</param> + <param name="state"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ContentDesignerState" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerBehavior.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerBehavior.xml index 5eedfea9172..624990036b9 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerBehavior.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerBehavior.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IControlDesignerBehavior" FullName="System.Web.UI.Design.IControlDesignerBehavior"> <TypeSignature Language="C#" Value="public interface IControlDesignerBehavior" /> <AssemblyInfo> @@ -7,8 +8,16 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.IControlDesignerBehavior" /> interface is obsolete. Use the <see cref="T:System.Web.UI.Design.IControlDesignerTag" /> and <see cref="T:System.Web.UI.Design.IControlDesignerView" /> interfaces for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enables the extension of specific behaviors of a control designer.</para> + </summary> </Docs> <Members> <Member MemberName="DesignTimeElementView"> @@ -18,9 +27,17 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.IControlDesignerBehavior" /> interface is obsolete. Use the <see cref="T:System.Web.UI.Design.IControlDesignerTag" /> and <see cref="T:System.Web.UI.Design.IControlDesignerView" /> interfaces for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design-time view control object for the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +51,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.IControlDesignerBehavior" /> interface is obsolete. Use the <see cref="T:System.Web.UI.Design.IControlDesignerTag" /> and <see cref="T:System.Web.UI.Design.IControlDesignerView" /> interfaces for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the design-time HTML for the designer's control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -51,8 +76,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para> + <para>The <see cref="M:System.Web.UI.Design.IControlDesignerBehavior.OnTemplateModeChanged" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an opportunity to perform processing when the designer enters or exits template mode.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -65,4 +97,4 @@ <AttributeName>System.Obsolete("Use IControlDesignerTag interface instead")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerTag.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerTag.xml index bea4011bd22..6c586809988 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerTag.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerTag.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IControlDesignerTag" FullName="System.Web.UI.Design.IControlDesignerTag"> <TypeSignature Language="C#" Value="public interface IControlDesignerTag" /> <AssemblyInfo> @@ -6,8 +7,14 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.IControlDesignerTag" /> interface is the contract between the control designer and a design host that enables the design host to manipulate the HTML tag at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for design-time access to the HTML markup for a control that is associated with a control designer.</para> + </summary> </Docs> <Members> <Member MemberName="GetAttribute"> @@ -23,10 +30,14 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the value of the identified attribute on the tag.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the attribute.</param> </Docs> </Member> <Member MemberName="GetContent"> @@ -40,9 +51,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the HTML markup for the content of the tag.</para> + </summary> </Docs> </Member> <Member MemberName="GetOuterContent"> @@ -56,9 +70,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the complete HTML markup for the control, including the outer tags.</para> + </summary> </Docs> </Member> <Member MemberName="IsDirty"> @@ -71,9 +88,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether or not an attribute or the content of a tag has changed.</para> + </summary> </Docs> </Member> <Member MemberName="RemoveAttribute"> @@ -89,9 +109,13 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deletes the specified attribute from the tag.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the attribute.</param> </Docs> </Member> <Member MemberName="SetAttribute"> @@ -108,10 +132,15 @@ <Parameter Name="value" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the value of the specified attribute and creates the attribute, if necessary.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The attribute name.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The attribute value.</param> </Docs> </Member> <Member MemberName="SetContent"> @@ -127,9 +156,13 @@ <Parameter Name="content" Type="System.String" /> </Parameters> <Docs> - <param name="content">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the HTML markup for the content of the tag.</para> + </summary> + <param name="content"> + <attribution license="cc4" from="Microsoft" modified="false" />The HTML markup for the content of the tag.</param> </Docs> </Member> <Member MemberName="SetDirty"> @@ -145,10 +178,14 @@ <Parameter Name="dirty" Type="System.Boolean" /> </Parameters> <Docs> - <param name="dirty">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the <see cref="P:System.Web.UI.Design.IControlDesignerTag.IsDirty" /> property of the tag.</para> + </summary> + <param name="dirty"> + <attribution license="cc4" from="Microsoft" modified="false" />The value for the <see cref="P:System.Web.UI.Design.IControlDesignerTag.IsDirty" /> property.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerView.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerView.xml index 5115163d986..19345ad712b 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerView.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IControlDesignerView.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IControlDesignerView" FullName="System.Web.UI.Design.IControlDesignerView"> <TypeSignature Language="C#" Value="public interface IControlDesignerView" /> <AssemblyInfo> @@ -6,8 +7,14 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This interface is intended for use by design host developers.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for access to the visual representation and content of a control at design time.</para> + </summary> </Docs> <Members> <Member MemberName="ContainingRegion"> @@ -20,9 +27,12 @@ <ReturnType>System.Web.UI.Design.DesignerRegion</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the designer region that contains the associated control, if any.</para> + </summary> </Docs> </Member> <Member MemberName="GetBounds"> @@ -38,10 +48,14 @@ <Parameter Name="region" Type="System.Web.UI.Design.DesignerRegion" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the outer bounds of the designer view.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.DesignerRegion" /> for which you want to retrieve the bounds.</param> </Docs> </Member> <Member MemberName="Invalidate"> @@ -57,9 +71,13 @@ <Parameter Name="rectangle" Type="System.Drawing.Rectangle" /> </Parameters> <Docs> - <param name="rectangle">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Notifies the design host that the area represented by the provided rectangle needs to be repainted on the design surface.</para> + </summary> + <param name="rectangle"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Rectangle" /> representing the location and outer measurements of the view on the design surface. The coordinate-system origin for this rectangle is the top-left corner of the element to which the behavior is attached.</param> </Docs> </Member> <Member MemberName="NamingContainerDesigner"> @@ -72,9 +90,12 @@ <ReturnType>System.ComponentModel.Design.IDesigner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the designer component for the naming container of the associated control, if any.</para> + </summary> </Docs> </Member> <Member MemberName="SetFlags"> @@ -91,10 +112,15 @@ <Parameter Name="setFlag" Type="System.Boolean" /> </Parameters> <Docs> - <param name="viewFlags">To be added.</param> - <param name="setFlag">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Web.UI.Design.IControlDesignerView.SetFlags(System.Web.UI.Design.ViewFlags,System.Boolean)" />.</para> + </summary> + <param name="viewFlags"> + <attribution license="cc4" from="Microsoft" modified="false" />A member of the <see cref="T:System.Web.UI.Design.ViewFlags" /> enumeration.</param> + <param name="setFlag"> + <attribution license="cc4" from="Microsoft" modified="false" />true to set the flag, false to cancel the flag.</param> </Docs> </Member> <Member MemberName="SetRegionContent"> @@ -111,10 +137,15 @@ <Parameter Name="content" Type="System.String" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <param name="content">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Puts the provided content into the provided designer region.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.DesignerRegion" /> into which the content is to be put.</param> + <param name="content"> + <attribution license="cc4" from="Microsoft" modified="false" />The HTML markup to be put into the designer region.</param> </Docs> </Member> <Member MemberName="SupportsRegions"> @@ -127,9 +158,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether designer regions are supported.</para> + </summary> </Docs> </Member> <Member MemberName="Update"> @@ -143,8 +177,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Causes the associated control to redraw the invalidated regions within its client area.</para> + </summary> </Docs> </Member> <Member MemberName="ViewEvent"> @@ -157,9 +194,26 @@ <ReturnType>System.Web.UI.Design.ViewEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> is raised by the design host if any of the following occur:</para> + <list type="bullet"> + <item> + <para>The user clicks on the view in the design host,</para> + </item> + <item> + <para>The design host repaints the client region on the design surface,</para> + </item> + <item> + <para>The user has elected to change the editing mode of an editable region corresponding to a template.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An event raised by the design host for the view and designer component.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataBindingSchemaProvider.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataBindingSchemaProvider.xml index 19df7b630b5..e528df54489 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataBindingSchemaProvider.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataBindingSchemaProvider.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDataBindingSchemaProvider" FullName="System.Web.UI.Design.IDataBindingSchemaProvider"> <TypeSignature Language="C#" Value="public interface IDataBindingSchemaProvider" /> <AssemblyInfo> @@ -6,8 +7,14 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.IDataBindingSchemaProvider" /> class is implemented by design hosts, such as vsprvslong, that host the data-binding dialog box to show schema.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for design-time access to a schema provider in a design host.</para> + </summary> </Docs> <Members> <Member MemberName="CanRefreshSchema"> @@ -20,9 +27,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the provider can refresh the schema.</para> + </summary> </Docs> </Member> <Member MemberName="RefreshSchema"> @@ -38,9 +48,16 @@ <Parameter Name="preferSilent" Type="System.Boolean" /> </Parameters> <Docs> - <param name="preferSilent">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.IDataBindingSchemaProvider.RefreshSchema(System.Boolean)" /> method is called by the design host only if the <see cref="P:System.Web.UI.Design.IDataBindingSchemaProvider.CanRefreshSchema" /> property is true.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Refreshes the schema for the data source.</para> + </summary> + <param name="preferSilent"> + <attribution license="cc4" from="Microsoft" modified="false" />true to disable data-binding events until after the schema has been refreshed; false to enable the events.</param> </Docs> </Member> <Member MemberName="Schema"> @@ -53,10 +70,13 @@ <ReturnType>System.Web.UI.Design.IDataSourceViewSchema</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the current schema object for the designer.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceDesigner.xml index 29e51544d23..8c170e18a43 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDataSourceDesigner" FullName="System.Web.UI.Design.IDataSourceDesigner"> <TypeSignature Language="C#" Value="public interface IDataSourceDesigner" /> <AssemblyInfo> @@ -6,8 +7,18 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.IDataSourceDesigner" /> interface defines an interface through which you can implement basic services for a data source designer. A designer is only active at design time, and must be associated with a data source, using a <see cref="T:System.ComponentModel.DesignerAttribute" />, in order to be loaded when a data source of the associated type is created at design time.</para> + <para>The <see cref="T:System.Web.UI.Design.IDataSourceDesigner" /> interface provides methods and properties that you can implement in order to provide custom behavior at design time.</para> + <para>A designer can also use the available design-time services to perform a variety of tasks, including surveying the current design-time environment for components and their properties, reading and setting the values of properties of components, managing the toolbox, managing selected components, or displaying a user interface that can be used to configure values or to apply further processing.</para> + <para>In most cases, implement your custom designer for a data source by deriving it from the <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class. Data sources whose associated designer does not derive from <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> are displayed in the component tray. The <see cref="T:System.Web.UI.Design.DataSourceDesigner" /> class implements the <see cref="T:System.Web.UI.Design.IDataSourceDesigner" /> interface and provides additional design-time support that may be of use to authors of designers. For more information, see the reference documentation for these classes.</para> + <para>For an overview of creating design components, see <format type="text/html"><a href="d6ac8a6a-42fd-4bc8-bf33-b212811297e2">Extending Design-Time Support</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines the basic functionality for a data source designer.</para> + </summary> </Docs> <Members> <Member MemberName="CanConfigure"> @@ -20,9 +31,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the <see cref="M:System.Web.UI.Design.IDataSourceDesigner.Configure" /> method can be called.</para> + </summary> </Docs> </Member> <Member MemberName="CanRefreshSchema"> @@ -35,9 +49,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the <see cref="M:System.Web.UI.Design.IDataSourceDesigner.RefreshSchema(System.Boolean)" /> method can be called.</para> + </summary> </Docs> </Member> <Member MemberName="Configure"> @@ -51,8 +68,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method can be called only if <see cref="P:System.Web.UI.Design.IDataSourceDesigner.CanConfigure" /> is true.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Launches the underlying data source's configuration wizard.</para> + </summary> </Docs> </Member> <Member MemberName="DataSourceChanged"> @@ -65,8 +88,14 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.Web.UI.Design.IDataSourceDesigner.DataSourceChanged" /> event occurs when the value of a field in the data source, or a property in the data-bound control that affects the data bindings to that field, has changed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a data source has changed in a way that affects data-bound controls.</para> + </summary> </Docs> </Member> <Member MemberName="GetView"> @@ -82,10 +111,18 @@ <Parameter Name="viewName" Type="System.String" /> </Parameters> <Docs> - <param name="viewName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A class that implements <see cref="T:System.Web.UI.Design.IDataSourceDesigner" /> can define a view in a way that is useful within the context of that class.</para> + <para>Use the <see cref="M:System.Web.UI.Design.IDataSourceDesigner.GetViewNames" /> method to get a list of view names.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Web.UI.Design.DesignerDataSourceView" /> for the specified view.</para> + </summary> + <param name="viewName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of a view in the underlying data source.</param> </Docs> </Member> <Member MemberName="GetViewNames"> @@ -99,9 +136,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the names of the views in the underlying data source.</para> + </summary> </Docs> </Member> <Member MemberName="RefreshSchema"> @@ -117,9 +157,13 @@ <Parameter Name="preferSilent" Type="System.Boolean" /> </Parameters> <Docs> - <param name="preferSilent">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Refreshes the schema of the underlying data source.</para> + </summary> + <param name="preferSilent"> + <attribution license="cc4" from="Microsoft" modified="false" />Indicates whether to suppress any events raised while refreshing the schema.</param> </Docs> </Member> <Member MemberName="ResumeDataSourceEvents"> @@ -133,8 +177,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Resumes raising data source events after calling the <see cref="M:System.Web.UI.Design.IDataSourceDesigner.SuppressDataSourceEvents" /> method.</para> + </summary> </Docs> </Member> <Member MemberName="SchemaRefreshed"> @@ -147,8 +194,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the fields or data of the underlying data source have changed.</para> + </summary> </Docs> </Member> <Member MemberName="SuppressDataSourceEvents"> @@ -162,9 +212,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Suppresses all events raised by a data source until the <see cref="M:System.Web.UI.Design.IDataSourceDesigner.ResumeDataSourceEvents" /> method is called.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceFieldSchema.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceFieldSchema.xml index fde6bad96ac..923ffcc6b39 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceFieldSchema.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceFieldSchema.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDataSourceFieldSchema" FullName="System.Web.UI.Design.IDataSourceFieldSchema"> <TypeSignature Language="C#" Value="public interface IDataSourceFieldSchema" /> <AssemblyInfo> @@ -6,9 +7,16 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.IDataSourceFieldSchema" /> interface allows a class to implement a set of properties that describe a field in a data source. The <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class implements the <see cref="T:System.Web.UI.Design.IDataSourceFieldSchema" /> interface.</para> + <para>Classes that implement the <see cref="T:System.Web.UI.Design.IDataSourceFieldSchema" /> are used by custom control designer components to provide lists of data source fields and properties for data-bound controls at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides basic functionality for describing the structure of a data field at design time.</para> + </summary> </Docs> <Members> <Member MemberName="DataType"> @@ -18,10 +26,13 @@ <ReturnType>System.Type</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type of data stored in the field.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -34,10 +45,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a <see cref="T:System.Data.DataColumn" /> object, the <see cref="P:System.Web.UI.Design.IDataSourceFieldSchema.Identity" /> property corresponds to the <see cref="P:System.Data.DataColumn.AutoIncrement" /> property. In SQL Server, an Identity column is a numerical column that automatically increments with each added record, thereby ensuring that the value uniquely identifies that record.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the value of the field automatically increments for each new row.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -50,10 +67,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a <see cref="T:System.Data.DataColumn" />, the <see cref="P:System.Web.UI.Design.IDataSourceFieldSchema.IsReadOnly" /> property corresponds to the <see cref="P:System.Data.DataColumn.ReadOnly" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the field is editable.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -66,10 +89,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a <see cref="T:System.Data.DataColumn" /> object, the <see cref="P:System.Web.UI.Design.IDataSourceFieldSchema.IsUnique" /> property corresponds to the <see cref="P:System.Data.DataColumn.Unique" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether values in the field are required to be unique.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -82,10 +111,16 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a <see cref="T:System.Data.DataColumn" /> object, the <see cref="P:System.Web.UI.Design.IDataSourceFieldSchema.Length" /> property corresponds to the <see cref="P:System.Data.DataColumn.MaxLength" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicting the size of data that can be stored in the field.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -98,10 +133,16 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a <see cref="T:System.Data.DataColumn" />object, the <see cref="P:System.Web.UI.Design.IDataSourceFieldSchema.Name" /> property corresponds to the <see cref="P:System.Data.DataColumn.ColumnName" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the field.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -114,10 +155,16 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a <see cref="T:System.Data.DataColumn" /> object, the <see cref="P:System.Web.UI.Design.IDataSourceFieldSchema.Nullable" /> property corresponds to the <see cref="P:System.Data.DataColumn.AllowDBNull" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the field can accept null values.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -130,10 +177,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the maximum number of digits used to represent a numerical value in the field.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -146,10 +196,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the field is in the primary key.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -162,14 +215,17 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of decimal places to which numerical values in the field are resolved.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceProvider.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceProvider.xml index 00bdad0c018..6778351b7b9 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceProvider.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceProvider.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDataSourceProvider" FullName="System.Web.UI.Design.IDataSourceProvider"> <TypeSignature Language="C#" Value="public interface IDataSourceProvider" /> <AssemblyInfo> @@ -7,8 +8,14 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A class that is able to provide a data source can implement this interface to enable access to its data source by objects that use the <see cref="T:System.Web.UI.Design.IDataSourceProvider" /> interface. This interface is used by the <see cref="T:System.Web.UI.Design.DataFieldConverter" /> and <see cref="T:System.Web.UI.Design.DataMemberConverter" /> classes.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines an interface that a control designer can implement to provide access to a data source.</para> + </summary> </Docs> <Members> <Member MemberName="GetResolvedSelectedDataSource"> @@ -19,9 +26,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the selected data member from the selected data source.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -36,9 +46,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a reference to the selected data source from the data source provider.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -46,4 +59,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceSchema.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceSchema.xml index cef943c63f7..f81f0aa91c4 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceSchema.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceSchema.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDataSourceSchema" FullName="System.Web.UI.Design.IDataSourceSchema"> <TypeSignature Language="C#" Value="public interface IDataSourceSchema" /> <AssemblyInfo> @@ -6,8 +7,15 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Implement the <see cref="T:System.Web.UI.Design.IDataSourceSchema" /> interface to describe a custom data source at design time. For example, the <see cref="T:System.Web.UI.Design.DataSetSchema" />, <see cref="T:System.Web.UI.Design.XmlDocumentSchema" />, and <see cref="T:System.Web.UI.Design.TypeSchema" /> classes implement the <see cref="T:System.Web.UI.Design.IDataSourceSchema" /> interface.</para> + <para>Classes that implement the <see cref="T:System.Web.UI.Design.IDataSourceSchema" /> are used by custom control designer components to provide lists of fields and views for data-bound controls at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides basic functionality for describing the structure of a data source at design time.</para> + </summary> </Docs> <Members> <Member MemberName="GetViews"> @@ -21,10 +29,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A class that implements the <see cref="M:System.Web.UI.Design.IDataSourceSchema.GetViews" /> method returns an array of objects that implement the <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" /> interface. For example, in the array returned by the <see cref="M:System.Web.UI.Design.DataSetSchema.GetViews" /> method, each element of the array is a <see cref="T:System.Web.UI.Design.DataSetViewSchema" /> object that implements <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array of schema descriptors for views contained in the data source.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceViewSchema.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceViewSchema.xml index af88c61167b..0c5c34bc777 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceViewSchema.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDataSourceViewSchema.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDataSourceViewSchema" FullName="System.Web.UI.Design.IDataSourceViewSchema"> <TypeSignature Language="C#" Value="public interface IDataSourceViewSchema" /> <AssemblyInfo> @@ -6,8 +7,14 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Classes that implement the <see cref="T:System.Web.UI.Design.IDataSourceSchema" /> class are used by custom control designer components to provide lists of views in a data source for data-bound controls at design time. In a class that is derived from the <see cref="T:System.Web.UI.Design.IDataSourceSchema" />, use the <see cref="M:System.Web.UI.Design.IDataSourceSchema.GetViews" /> method to get an array of <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" /> objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines a set of methods and properties used to examine a data source.</para> + </summary> </Docs> <Members> <Member MemberName="GetChildren"> @@ -21,9 +28,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.XmlDocumentSchema" /> class implements the <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" /> interface. It uses its implementation of the <see cref="M:System.Web.UI.Design.IDataSourceViewSchema.GetChildren" /> method to create an array of <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" /> objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array representing the child views contained in the current view.</para> + </summary> </Docs> </Member> <Member MemberName="GetFields"> @@ -37,9 +50,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.DataSetSchema" /> class implements the <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" /> interface; its implementation of the <see cref="M:System.Web.UI.Design.DataSetViewSchema.GetFields" /> method returns an array of <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> objects, each of which derives from the <see cref="T:System.Web.UI.Design.IDataSourceFieldSchema" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array containing information about each field in the data source.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -52,10 +71,16 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a <see cref="T:System.Data.DataTable" /> object, this property corresponds to the <see cref="P:System.Data.DataTable.TableName" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the view.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDesignTimeResourceProviderFactoryService.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDesignTimeResourceProviderFactoryService.xml index 03581f085ae..8a65b3e3f79 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDesignTimeResourceProviderFactoryService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDesignTimeResourceProviderFactoryService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDesignTimeResourceProviderFactoryService" FullName="System.Web.UI.Design.IDesignTimeResourceProviderFactoryService"> <TypeSignature Language="C#" Value="public interface IDesignTimeResourceProviderFactoryService" /> <AssemblyInfo> @@ -6,8 +7,11 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for creating a custom <see cref="T:System.Web.UI.Design.DesignTimeResourceProviderFactory" /> class.</para> + </summary> </Docs> <Members> <Member MemberName="GetFactory"> @@ -21,10 +25,13 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a <see cref="T:System.Web.UI.Design.DesignTimeResourceProviderFactory" /> object.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDesignTimeResourceWriter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDesignTimeResourceWriter.xml index 259f397da4b..2e211a63481 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDesignTimeResourceWriter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDesignTimeResourceWriter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDesignTimeResourceWriter" FullName="System.Web.UI.Design.IDesignTimeResourceWriter"> <TypeSignature Language="C#" Value="public interface IDesignTimeResourceWriter : System.Resources.IResourceWriter" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Used by the <see cref="T:System.Web.UI.Design.DesignTimeResourceProviderFactory" /> class to localize data at design time.</para> + </summary> </Docs> <Members> <Member MemberName="CreateResourceKey"> @@ -28,12 +32,17 @@ <Parameter Name="obj" Type="System.Object" /> </Parameters> <Docs> - <param name="resourceName">To be added.</param> - <param name="obj">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a key, using the provided string, to use to retrieve data from the given resource.</para> + </summary> + <param name="resourceName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the resource.</param> + <param name="obj"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to localize.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDocumentProjectItem.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDocumentProjectItem.xml index 8ab211fae25..c314979d04f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDocumentProjectItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IDocumentProjectItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IDocumentProjectItem" FullName="System.Web.UI.Design.IDocumentProjectItem"> <TypeSignature Language="C#" Value="public interface IDocumentProjectItem" /> <AssemblyInfo> @@ -6,8 +7,11 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for accessing a document item retrieved from a design host at design time.</para> + </summary> </Docs> <Members> <Member MemberName="GetContents"> @@ -21,9 +25,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides access to the contents of a document item that is retrieved from the design host.</para> + </summary> </Docs> </Member> <Member MemberName="Open"> @@ -37,9 +44,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Opens a document item that is retrieved from the design host.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IFolderProjectItem.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IFolderProjectItem.xml index da0d4be1c4f..48999b6b7e3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IFolderProjectItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IFolderProjectItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IFolderProjectItem" FullName="System.Web.UI.Design.IFolderProjectItem"> <TypeSignature Language="C#" Value="public interface IFolderProjectItem" /> <AssemblyInfo> @@ -6,8 +7,11 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for a project folder in a design host, such as vsprvslong.</para> + </summary> </Docs> <Members> <Member MemberName="AddDocument"> @@ -24,11 +28,16 @@ <Parameter Name="content" Type="System.Byte[]" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="content">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a document to a project folder in a design host, such as vsprvslong.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the document.</param> + <param name="content"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Byte" /> containing the document contents.</param> </Docs> </Member> <Member MemberName="AddFolder"> @@ -44,10 +53,14 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new folder in a project folder of a design host, such as vsprvslong.</para> + </summary> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name for the new folder.</param> </Docs> </Member> <Member MemberName="Children"> @@ -60,10 +73,13 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of items in a project folder in a design host, such as vsprvslong.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IHierarchicalDataSourceDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IHierarchicalDataSourceDesigner.xml index a9e24a64693..82d3c8b1081 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IHierarchicalDataSourceDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IHierarchicalDataSourceDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IHierarchicalDataSourceDesigner" FullName="System.Web.UI.Design.IHierarchicalDataSourceDesigner"> <TypeSignature Language="C#" Value="public interface IHierarchicalDataSourceDesigner" /> <AssemblyInfo> @@ -6,8 +7,14 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Typically, when creating a new data source class for hierarchical data and an accompanying designer, you would inherit the <see cref="T:System.Web.UI.Design.HierarchicalDataSourceDesigner" /> class rather than implement the <see cref="T:System.Web.UI.Design.IHierarchicalDataSourceDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides design-time support in a visual designer for a class that is derived from the <see cref="T:System.Web.UI.HierarchicalDataSourceControl" /> class.</para> + </summary> </Docs> <Members> <Member MemberName="CanConfigure"> @@ -20,9 +27,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.IHierarchicalDataSourceDesigner.CanConfigure" /> property is used by a design host, such as vsprvslong, to determine whether to display a <ui>Configure</ui> command at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="M:System.Web.UI.Design.IHierarchicalDataSourceDesigner.Configure" /> method can be called.</para> + </summary> </Docs> </Member> <Member MemberName="CanRefreshSchema"> @@ -35,9 +48,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.IHierarchicalDataSourceDesigner.CanRefreshSchema" /> property is used by a design host, such as vsprvslong, to determine whether to display a <ui>Refresh Schema</ui> command at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="M:System.Web.UI.Design.IHierarchicalDataSourceDesigner.RefreshSchema(System.Boolean)" /> method can be called.</para> + </summary> </Docs> </Member> <Member MemberName="Configure"> @@ -51,8 +70,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Launches the configuration wizard for the underlying data source.</para> + </summary> </Docs> </Member> <Member MemberName="DataSourceChanged"> @@ -65,8 +87,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a data source control has changed in some way that affects data-bound controls.</para> + </summary> </Docs> </Member> <Member MemberName="GetView"> @@ -82,10 +107,14 @@ <Parameter Name="viewPath" Type="System.String" /> </Parameters> <Docs> - <param name="viewPath">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the named data source view that is associated with the data source control.</para> + </summary> + <param name="viewPath"> + <attribution license="cc4" from="Microsoft" modified="false" />The XPath for the part of the data source to retrieve.</param> </Docs> </Member> <Member MemberName="RefreshSchema"> @@ -101,9 +130,13 @@ <Parameter Name="preferSilent" Type="System.Boolean" /> </Parameters> <Docs> - <param name="preferSilent">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Refreshes the schema of the underlying data source.</para> + </summary> + <param name="preferSilent"> + <attribution license="cc4" from="Microsoft" modified="false" />true to suppress events raised while refreshing the schema; otherwise false.</param> </Docs> </Member> <Member MemberName="ResumeDataSourceEvents"> @@ -117,8 +150,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Restores events after calling the <see cref="M:System.Web.UI.Design.IHierarchicalDataSourceDesigner.SuppressDataSourceEvents" /> method.</para> + </summary> </Docs> </Member> <Member MemberName="SchemaRefreshed"> @@ -131,8 +167,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the fields or data of the underlying data source have changed.</para> + </summary> </Docs> </Member> <Member MemberName="SuppressDataSourceEvents"> @@ -146,9 +185,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You can restore events with the <see cref="M:System.Web.UI.Design.IHierarchicalDataSourceDesigner.ResumeDataSourceEvents" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Turns off events in the data source control.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IHtmlControlDesignerBehavior.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IHtmlControlDesignerBehavior.xml index b5406648fd9..dd85eb3e108 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IHtmlControlDesignerBehavior.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IHtmlControlDesignerBehavior.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IHtmlControlDesignerBehavior" FullName="System.Web.UI.Design.IHtmlControlDesignerBehavior"> <TypeSignature Language="C#" Value="public interface IHtmlControlDesignerBehavior" /> <AssemblyInfo> @@ -7,8 +8,16 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.IHtmlControlDesignerBehavior" /> interface is obsolete. Use the <see cref="T:System.Web.UI.Design.IControlDesignerTag" /> and <see cref="T:System.Web.UI.Design.IControlDesignerView" /> interfaces for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines an interface that enables the extension of specific behaviors of an HTML control designer.</para> + </summary> </Docs> <Members> <Member MemberName="Designer"> @@ -18,9 +27,12 @@ <ReturnType>System.Web.UI.Design.HtmlControlDesigner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the designer that the behavior is associated with.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +46,12 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the element that the designer is associated with.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -54,11 +69,21 @@ <Parameter Name="ignoreCase" Type="System.Boolean" /> </Parameters> <Docs> - <param name="attribute">To be added.</param> - <param name="ignoreCase">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.IHtmlControlDesignerBehavior.GetAttribute(System.String,System.Boolean)" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.IControlDesignerTag.GetAttribute(System.String)" /> method on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property of the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the specified attribute.</para> + </summary> + <param name="attribute"> + <attribution license="cc4" from="Microsoft" modified="false" />The attribute to retrieve. </param> + <param name="ignoreCase"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the attribute syntax is case-insensitive; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -77,12 +102,23 @@ <Parameter Name="ignoreCase" Type="System.Boolean" /> </Parameters> <Docs> - <param name="attribute">To be added.</param> - <param name="designTimeOnly">To be added.</param> - <param name="ignoreCase">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.IHtmlControlDesignerBehavior.GetStyleAttribute(System.String,System.Boolean,System.Boolean)" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeCssAttributes" /> method on the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the specified style attribute.</para> + </summary> + <param name="attribute"> + <attribution license="cc4" from="Microsoft" modified="false" />The style attribute to retrieve. </param> + <param name="designTimeOnly"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the attribute is only active at design time; otherwise, false. </param> + <param name="ignoreCase"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the attribute syntax is case-insensitive; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -100,10 +136,20 @@ <Parameter Name="ignoreCase" Type="System.Boolean" /> </Parameters> <Docs> - <param name="attribute">To be added.</param> - <param name="ignoreCase">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.IHtmlControlDesignerBehavior.RemoveAttribute(System.String,System.Boolean)" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.IControlDesignerTag.RemoveAttribute(System.String)" /> method on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property of the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified attribute.</para> + </summary> + <param name="attribute"> + <attribution license="cc4" from="Microsoft" modified="false" />The attribute to remove. </param> + <param name="ignoreCase"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the attribute syntax is case-insensitive; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -122,11 +168,17 @@ <Parameter Name="ignoreCase" Type="System.Boolean" /> </Parameters> <Docs> - <param name="attribute">To be added.</param> - <param name="designTimeOnly">To be added.</param> - <param name="ignoreCase">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified style attribute.</para> + </summary> + <param name="attribute"> + <attribution license="cc4" from="Microsoft" modified="false" />The style attribute to remove. </param> + <param name="designTimeOnly"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the attribute is only active at design time; otherwise, false. </param> + <param name="ignoreCase"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the attribute syntax is case-insensitive; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -145,11 +197,22 @@ <Parameter Name="ignoreCase" Type="System.Boolean" /> </Parameters> <Docs> - <param name="attribute">To be added.</param> - <param name="value">To be added.</param> - <param name="ignoreCase">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.IHtmlControlDesignerBehavior.SetAttribute(System.String,System.Object,System.Boolean)" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.IControlDesignerTag.SetAttribute(System.String,System.String)" /> method on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property of the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the specified attribute to the specified object.</para> + </summary> + <param name="attribute"> + <attribution license="cc4" from="Microsoft" modified="false" />The attribute to set. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object on which to set the attribute. </param> + <param name="ignoreCase"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the attribute syntax is case-insensitive; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -169,12 +232,24 @@ <Parameter Name="ignoreCase" Type="System.Boolean" /> </Parameters> <Docs> - <param name="attribute">To be added.</param> - <param name="designTimeOnly">To be added.</param> - <param name="value">To be added.</param> - <param name="ignoreCase">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.IHtmlControlDesignerBehavior.SetStyleAttribute(System.String,System.Boolean,System.Object,System.Boolean)" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.AddDesignTimeCssAttributes(System.Collections.IDictionary)" /> method on the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the specified style attribute to the specified object.</para> + </summary> + <param name="attribute"> + <attribution license="cc4" from="Microsoft" modified="false" />The attribute to set. </param> + <param name="designTimeOnly"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the attribute is only active at design-time; otherwise, false. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to set the attribute on. </param> + <param name="ignoreCase"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the attribute syntax is case-insensitive; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -187,4 +262,4 @@ <AttributeName>System.Obsolete("Use IControlDesignerTag and IControlDesignerView instead")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IProjectItem.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IProjectItem.xml index a6818944063..00b40cba64e 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IProjectItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IProjectItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IProjectItem" FullName="System.Web.UI.Design.IProjectItem"> <TypeSignature Language="C#" Value="public interface IProjectItem" /> <AssemblyInfo> @@ -6,9 +7,12 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for an item that is retrieved at design time from a design host, such as vsprvslong.</para> + </summary> </Docs> <Members> <Member MemberName="AppRelativeUrl"> @@ -18,10 +22,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the URL for the item relative to the design host.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -34,10 +41,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the item.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -50,10 +60,13 @@ <ReturnType>System.Web.UI.Design.IProjectItem</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a reference to the containing item, if any.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -66,14 +79,20 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.IProjectItem.PhysicalPath" /> property returns the physical path for a given project item if the design host supports this feature and if it makes sense to retrieve a physical path for the item. If the item is a non-disk item, such as a Web site or an FTP site, the <see cref="P:System.Web.UI.Design.IProjectItem.PhysicalPath" /> property should return null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the path for a project item.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ITemplateEditingFrame.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ITemplateEditingFrame.xml index 3447cc8798b..935793cc23c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ITemplateEditingFrame.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ITemplateEditingFrame.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ITemplateEditingFrame" FullName="System.Web.UI.Design.ITemplateEditingFrame"> <TypeSignature Language="C#" Value="public interface ITemplateEditingFrame : IDisposable" /> <AssemblyInfo> @@ -11,8 +12,17 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. Use the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property to access template groups, and template definitions within template groups, for a control designer.</para> + </block> + <para>A template editing frame represents the UI for a template editor of a templated control designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface to manage a template editing area.</para> + </summary> </Docs> <Members> <Member MemberName="Close"> @@ -25,9 +35,18 @@ <Parameter Name="saveChanges" Type="System.Boolean" /> </Parameters> <Docs> - <param name="saveChanges">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplateGroup.GroupStyle" /> property on each template group element in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection of a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Closes the control and optionally saves any changes.</para> + </summary> + <param name="saveChanges"> + <attribution license="cc4" from="Microsoft" modified="false" />true if changes to the document should be saved; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -41,9 +60,17 @@ <ReturnType>System.Web.UI.WebControls.Style</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplateGroup.GroupStyle" /> property on each template group element in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection of a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the style for the editing frame.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -57,9 +84,17 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. Use the <see cref="P:System.Web.UI.WebControls.Style.Height" /> property in the <see cref="P:System.Web.UI.Design.TemplateGroup.GroupStyle" /> property for each template group element in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection of a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the initial height of the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -73,9 +108,17 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. Use the <see cref="P:System.Web.UI.WebControls.Style.Width" /> property in the <see cref="P:System.Web.UI.Design.TemplateGroup.GroupStyle" /> property for each template group element in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection of a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the initial width of the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -89,9 +132,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. The template group name is provided in the <see cref="P:System.Web.UI.Design.TemplateGroup.GroupName" /> property of each template group element in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection of a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the editing frame.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -106,8 +157,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Opens and displays the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -125,10 +179,20 @@ <Parameter Name="height" Type="System.Int32" /> </Parameters> <Docs> - <param name="width">To be added.</param> - <param name="height">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplateGroup.GroupStyle" /> property on each template group element in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection of a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Resizes the control to the specified width and height.</para> + </summary> + <param name="width"> + <attribution license="cc4" from="Microsoft" modified="false" />The new width for the control. </param> + <param name="height"> + <attribution license="cc4" from="Microsoft" modified="false" />The new height for the control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -143,8 +207,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Saves any changes to the document.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -158,9 +225,17 @@ <ReturnType>System.String[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. A template name is provided through the <see cref="P:System.Web.UI.Design.DesignerObject.Name" /> property of a <see cref="T:System.Web.UI.Design.TemplateDefinition" /> object. Enumerate the collection of template definitions by using the <see cref="P:System.Web.UI.Design.TemplateGroup.Templates" /> property of each <see cref="T:System.Web.UI.Design.TemplateGroup" /> element in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection of a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a set of names of templates to use.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -174,9 +249,17 @@ <ReturnType>System.Web.UI.WebControls.Style[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. A template style is provided through the <see cref="P:System.Web.UI.Design.TemplateDefinition.Style" /> property of a <see cref="T:System.Web.UI.Design.TemplateDefinition" /> object. Enumerate the collection of template definitions by using the <see cref="P:System.Web.UI.Design.TemplateGroup.Templates" /> property of each <see cref="T:System.Web.UI.Design.TemplateGroup" /> element in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection of a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the template styles for the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -193,9 +276,18 @@ <Parameter Name="newName" Type="System.String" /> </Parameters> <Docs> - <param name="newName">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplateGroup.GroupStyle" /> property on each template group element in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection of a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Changes the name of the control to the specified name.</para> + </summary> + <param name="newName"> + <attribution license="cc4" from="Microsoft" modified="false" />The new name for the control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -209,9 +301,17 @@ <ReturnType>System.Web.UI.Design.TemplateEditingVerb</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" /> interface is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplateGroup.GroupName" /> property of each template group in the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> collection for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the verb that invokes the template.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -224,4 +324,4 @@ <AttributeName>System.Obsolete("Template editing is supported in ControlDesigner.TemplateGroups with SetViewFlags(ViewFlags.TemplateEditing, true) in 2.0.")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ITemplateEditingService.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ITemplateEditingService.xml index 2bfe005f9bb..1dc081f17d0 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ITemplateEditingService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ITemplateEditingService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ITemplateEditingService" FullName="System.Web.UI.Design.ITemplateEditingService"> <TypeSignature Language="C#" Value="public interface ITemplateEditingService" /> <AssemblyInfo> @@ -7,8 +8,16 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingService" /> interface is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides services for editing control templates at design time.</para> + </summary> </Docs> <Members> <Member MemberName="CreateFrame"> @@ -23,12 +32,23 @@ <Parameter Name="templateNames" Type="System.String[]" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="frameName">To be added.</param> - <param name="templateNames">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingService" /> interface is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new template editing frame for the specified templated control designer, using the specified name and templates.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> that will use the template editing frame. </param> + <param name="frameName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the editing frame that will be displayed on the frame. Typically this is the same as the <see cref="P:System.ComponentModel.Design.DesignerVerb.Text" /> property used as the menu text for the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> that is invoked to create the frame. </param> + <param name="templateNames"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of names for the templates that the template editing frame will contain. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -49,14 +69,27 @@ <Parameter Name="templateStyles" Type="System.Web.UI.WebControls.Style[]" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="frameName">To be added.</param> - <param name="templateNames">To be added.</param> - <param name="controlStyle">To be added.</param> - <param name="templateStyles">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingService" /> interface is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new template editing frame for the specified <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" />, using the specified name, template names, control style, and template styles.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> that will use the template editing frame. </param> + <param name="frameName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the editing frame that will be displayed on the frame. Typically this is the same as the <see cref="P:System.ComponentModel.Design.DesignerVerb.Text" /> property used as the menu text for the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> that is invoked to create the frame. </param> + <param name="templateNames"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of names for the templates that the template editing frame will contain. </param> + <param name="controlStyle"> + <attribution license="cc4" from="Microsoft" modified="false" />The control <see cref="T:System.Web.UI.WebControls.Style" /> for the editing frame. </param> + <param name="templateStyles"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Web.UI.WebControls.Style" /> that represents the template styles for the editing frame. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -73,10 +106,19 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingService" /> interface is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplatedEditableDesignerRegion.TemplateDefinition" /> property of the <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> class for equivalent design time functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the parent template.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> for which to get the name of the parent template. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -90,9 +132,18 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This property indicates whether a template editor can be invoked from a component of a parent template editor's templated control. This is called nested template editing, because a template editor is invoked for a component of a control for which a template editor is already operating.</para> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ITemplateEditingService" /> interface is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the service supports nested template editing.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -105,4 +156,4 @@ <AttributeName>System.Obsolete("Template editing is supported in ControlDesigner.TemplateGroups with SetViewFlags(ViewFlags.TemplateEditing, true) in 2.0.")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebAdministrationService.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebAdministrationService.xml index 2c0dedb503b..7dc57c1e94c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebAdministrationService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebAdministrationService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IWebAdministrationService" FullName="System.Web.UI.Design.IWebAdministrationService"> <TypeSignature Language="C#" Value="public interface IWebAdministrationService" /> <AssemblyInfo> @@ -6,8 +7,14 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The specified arguments can be used to specify how the Web administration user interface (UI) should be launched. The arguments are optional and the design host can choose to ignore them.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for creating services for administering a Web site at design time.</para> + </summary> </Docs> <Members> <Member MemberName="Start"> @@ -23,10 +30,14 @@ <Parameter Name="arguments" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="arguments">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Starts the Web administration facility in the design host.</para> + </summary> + <param name="arguments"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebApplication.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebApplication.xml index 7e9e83250ec..c1951d215e9 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebApplication.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebApplication.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IWebApplication" FullName="System.Web.UI.Design.IWebApplication"> <TypeSignature Language="C#" Value="public interface IWebApplication : IServiceProvider" /> <AssemblyInfo> @@ -15,9 +16,12 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface for accessing a Web application in a design host, such as vsprvsext, at design time.</para> + </summary> </Docs> <Members> <Member MemberName="GetProjectItemFromUrl"> @@ -30,11 +34,15 @@ <Parameter Name="appRelativeUrl" Type="System.String" /> </Parameters> <Docs> - <param name="appRelativeUrl">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a project item from a design host based on its URL.</para> + </summary> + <param name="appRelativeUrl"> + <attribution license="cc4" from="Microsoft" modified="false" />The relative path to the project item to retrieve.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -50,11 +58,15 @@ <Parameter Name="isReadOnly" Type="System.Boolean" /> </Parameters> <Docs> - <param name="isReadOnly">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a <see cref="T:System.Configuration.Configuration" /> object representing the current Web application in the design host.</para> + </summary> + <param name="isReadOnly"> + <attribution license="cc4" from="Microsoft" modified="false" />true to indicate the returned <see cref="T:System.Configuration.Configuration" /> is editable; otherwise, false.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -67,14 +79,17 @@ <ReturnType>System.Web.UI.Design.IProjectItem</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the root project item from the design host.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormReferenceManager.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormReferenceManager.xml index 3aaa82f4223..b70a8bc1d35 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormReferenceManager.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormReferenceManager.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IWebFormReferenceManager" FullName="System.Web.UI.Design.IWebFormReferenceManager"> <TypeSignature Language="C#" Value="public interface IWebFormReferenceManager" /> <AssemblyInfo> @@ -7,8 +8,17 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" /> interface is obsolete. Use the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class for equivalent designer functionality.</para> + </block> + <para>A Web Forms document designer must implement this interface. Implementing this interface enables a designer to manage references and provide information related to Web Forms controls within the project.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an interface that can look up information about the types used in the current Web Forms project.</para> + </summary> </Docs> <Members> <Member MemberName="GetObjectType"> @@ -22,11 +32,21 @@ <Parameter Name="typeName" Type="System.String" /> </Parameters> <Docs> - <param name="tagPrefix">To be added.</param> - <param name="typeName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.IWebFormReferenceManager.GetObjectType(System.String,System.String)" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.WebFormsReferenceManager.GetType(System.String,System.String)" /> method on the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class for equivalent designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type of the specified object.</para> + </summary> + <param name="tagPrefix"> + <attribution license="cc4" from="Microsoft" modified="false" />The tag prefix for the type. </param> + <param name="typeName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the type. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -41,9 +61,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.IWebFormReferenceManager.GetRegisterDirectives" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.WebFormsReferenceManager.GetRegisterDirectives" /> method on the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class for equivalent designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the register directives for the current project.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -60,10 +88,19 @@ <Parameter Name="objectType" Type="System.Type" /> </Parameters> <Docs> - <param name="objectType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.IWebFormReferenceManager.GetTagPrefix(System.Type)" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.WebFormsReferenceManager.GetTagPrefix(System.Type)" /> method on the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class for equivalent designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the tag prefix for the specified type of object.</para> + </summary> + <param name="objectType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the object. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -76,4 +113,4 @@ <AttributeName>System.Obsolete("Use new WebFormsReferenceManager feature")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormsBuilderUIService.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormsBuilderUIService.xml index 0b05953fe4c..54a70d0f491 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormsBuilderUIService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormsBuilderUIService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IWebFormsBuilderUIService" FullName="System.Web.UI.Design.IWebFormsBuilderUIService"> <TypeSignature Language="C#" Value="public interface IWebFormsBuilderUIService" /> <AssemblyInfo> @@ -7,8 +8,11 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides methods to start specific user interfaces for building properties at design-time.</para> + </summary> </Docs> <Members> <Member MemberName="BuildColor"> @@ -22,11 +26,19 @@ <Parameter Name="initialColor" Type="System.String" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="initialColor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <paramref name="initialColor" /> parameter should be a named color, or an RGB color expressed in HTML color format (#RRGGBB).</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Starts a <see cref="T:System.Web.UI.Design.ColorBuilder" /> to build a color property.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The control used to parent the dialog shown by the <see cref="T:System.Web.UI.Design.ColorBuilder" />. </param> + <param name="initialColor"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial color for the editor to pre-select. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -48,15 +60,24 @@ <Parameter Name="options" Type="System.Web.UI.Design.UrlBuilderOptions" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="initialUrl">To be added.</param> - <param name="baseUrl">To be added.</param> - <param name="caption">To be added.</param> - <param name="filter">To be added.</param> - <param name="options">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Launches an editor to build a URL property.</para> + </summary> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The control used to parent the dialog shown by the <see cref="T:System.Web.UI.Design.UrlBuilder" />. </param> + <param name="initialUrl"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial URL to display in the selection interface. </param> + <param name="baseUrl"> + <attribution license="cc4" from="Microsoft" modified="false" />The base URL used to construct relative URLs. </param> + <param name="caption"> + <attribution license="cc4" from="Microsoft" modified="false" />A caption that presents a message in the selection interface. </param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />The filter string to use to optionally filter the files displayed in the selection interface. </param> + <param name="options"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.UrlBuilderOptions" /> that indicates the options for the <see cref="T:System.Web.UI.Design.UrlBuilder" />. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -64,4 +85,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormsDocumentService.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormsDocumentService.xml index cded3244631..b952efa5547 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormsDocumentService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/IWebFormsDocumentService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IWebFormsDocumentService" FullName="System.Web.UI.Design.IWebFormsDocumentService"> <TypeSignature Language="C#" Value="public interface IWebFormsDocumentService" /> <AssemblyInfo> @@ -7,8 +8,16 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.IWebFormsDocumentService" /> interface is obsolete. Use the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> class for equivalent designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides methods to access services for tracking the loading state of a Web Forms document, handling events at load time, accessing a document's location, managing a document's undo service, and setting a new selection within the document.</para> + </summary> </Docs> <Members> <Member MemberName="CreateDiscardableUndoUnit"> @@ -19,9 +28,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is obsolete and there is no equivalent functionality.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a discardable undo unit.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,9 +53,16 @@ <Parameter Name="discardableUndoUnit" Type="System.Object" /> </Parameters> <Docs> - <param name="discardableUndoUnit">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is obsolete and there is no equivalent functionality.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Discards the specified undo unit.</para> + </summary> + <param name="discardableUndoUnit"> + <attribution license="cc4" from="Microsoft" modified="false" />The undo unit to discard. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -54,9 +76,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="P:System.Web.UI.Design.IWebFormsDocumentService.DocumentUrl" /> interface property is obsolete. Use the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.DocumentUrl" /> property on the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> class for equivalent designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the URL at which the document is located.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -73,9 +103,16 @@ <Parameter Name="enable" Type="System.Boolean" /> </Parameters> <Docs> - <param name="enable">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is obsolete and there is no equivalent functionality.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enables the ability to undo actions that occur within undoable action units or transactions.</para> + </summary> + <param name="enable"> + <attribution license="cc4" from="Microsoft" modified="false" />true if actions should be undoable; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -89,9 +126,17 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="P:System.Web.UI.Design.IWebFormsDocumentService.IsLoading" /> interface property is obsolete. Use the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.IsLoading" /> property on the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> class for equivalent designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the document service is currently loading.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -105,8 +150,17 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="E:System.Web.UI.Design.IWebFormsDocumentService.LoadComplete" /> interface event is obsolete. Use the <see cref="E:System.Web.UI.Design.WebFormsRootDesigner.LoadComplete" /> event on the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> class for equivalent designer functionality.</para> + </block> + <para>This event provides an opportunity to perform operations immediately after loading has completed. Events that should occur at load time can be registered as event handlers for this event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the service has finished loading.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -121,8 +175,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is obsolete and there is no equivalent functionality.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When implemented in a derived class, updates the current selection.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -135,4 +195,4 @@ <AttributeName>System.Obsolete("Use new WebFormsReferenceManager feature")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ImageUrlEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ImageUrlEditor.xml index 42c45c6df49..7b8a877f89c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ImageUrlEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ImageUrlEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ImageUrlEditor" FullName="System.Web.UI.Design.ImageUrlEditor"> <TypeSignature Language="C#" Value="public class ImageUrlEditor : System.Web.UI.Design.UrlEditor" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.ImageUrlEditor" /> is a <see cref="T:System.Drawing.Design.UITypeEditor" /> that provides a dialog box for selecting a URL property that references an image.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for selecting a URL that references an image.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ImageUrlEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +45,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption to display on the selection dialog window.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -50,9 +64,18 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ImageUrlEditor.Filter" /> property specifies a filter string with two filter options: one for common image file extensions (*.gif, *.jpg, *.jpeg, *.bmp, *.wmf, *.png), and one for all files (*.*).</para> + <para>A filter string contains one or more filter options. Each filter option contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. </para> + <para>The following is an example of a filter string that contains two filter options: "Bitmap Files (*.bmp)|*.bmp|All Files (*.*)|*.*".</para> + <para>You can specify several filter patterns in a filter option by separating the filter patterns with semicolons. The following is an example of a filter string in which the first filter option specifies three filter patterns: "Image Files(*.bmp;*.jpg;*.gif)|*.bmp;*.jpg;*.gif|All Files (*.*)|*.*".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the file name filter string for the editor. This string is used to determine the items that appear in the file list of the dialog box.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -60,4 +83,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/MailFileEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/MailFileEditor.xml index 125120c5671..3228e0001c3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/MailFileEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/MailFileEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MailFileEditor" FullName="System.Web.UI.Design.MailFileEditor"> <TypeSignature Language="C#" Value="public class MailFileEditor : System.Web.UI.Design.UrlEditor" /> <AssemblyInfo> @@ -9,8 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.MailFileEditor" /> class is an <see cref="T:System.Drawing.Design.UITypeEditor" /> object that can be used at design time to select and edit a mail file name as a string, and assign the string to a control property. For example, the <see cref="T:System.Web.UI.WebControls.EmbeddedMailObject" /> control uses the <see cref="T:System.Web.UI.Design.MailFileEditor" /> class at design time to set the value of the <see cref="P:System.Web.UI.WebControls.EmbeddedMailObject.Path" /> property.</para> + <para>Use the <see cref="T:System.ComponentModel.EditorAttribute" /> attribute to associate the <see cref="T:System.Web.UI.Design.MailFileEditor" /> with a property. When the associated property is edited in the design surface, the designer host calls the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method. The <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method displays a dialog box for selecting a mail file name from a filtered list of files, and returns the file name that is selected by the user. The <see cref="Overload:System.Web.UI.Design.UrlEditor.GetEditStyle" /> method indicates the display style of the user interface.</para> + <para>Derive a class from the <see cref="T:System.Web.UI.Design.MailFileEditor" /> to define a custom editor for a mail file name property. For example, a derived class can override the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method, and display an <see cref="T:System.Windows.Forms.OpenFileDialog" /> instance with a custom mail file filter or title.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for selecting and editing a mail file name for a property at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +30,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.MailFileEditor" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Caption"> @@ -35,9 +47,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption for the editor dialog.</para> + </summary> </Docs> </Member> <Member MemberName="Filter"> @@ -50,10 +65,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the file filter string for the dialog (such as "*.txt").</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/MdbDataFileEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/MdbDataFileEditor.xml index dcc6863cacc..c623ea395b7 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/MdbDataFileEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/MdbDataFileEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MdbDataFileEditor" FullName="System.Web.UI.Design.MdbDataFileEditor"> <TypeSignature Language="C#" Value="public class MdbDataFileEditor : System.Web.UI.Design.UrlEditor" /> <AssemblyInfo> @@ -9,8 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An <see cref="T:System.Web.UI.Design.MdbDataFileEditor" /> object is used at design time to select and edit a URL for a Microsoft Access database file (.mdb), and then assign the URL to a control property. For example, the <see cref="T:System.Web.UI.WebControls.AccessDataSource" /> control uses the <see cref="T:System.Web.UI.Design.MdbDataFileEditor" /> class at design time to set the value of the <see cref="P:System.Web.UI.WebControls.AccessDataSource.DataFile" /> property.</para> + <para>Use the <see cref="T:System.ComponentModel.EditorAttribute" /> attribute to associate the <see cref="T:System.Web.UI.Design.MdbDataFileEditor" /> with a property. When the associated property is edited on the design surface, the designer host calls the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method. The <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method uses the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The <see cref="Overload:System.Web.UI.Design.UrlEditor.GetEditStyle" /> method indicates the display style of the user interface.</para> + <para>Derive a class from the <see cref="T:System.Web.UI.Design.MdbDataFileEditor" /> to define a custom editor for an Access database URL property. For example, a derived class can override the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method, and then call the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method with a custom <see cref="P:System.Web.UI.Design.MdbDataFileEditor.Filter" /> or <see cref="P:System.Web.UI.Design.MdbDataFileEditor.Caption" /> value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a design-time user interface for selecting a Microsoft Access database file.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +30,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.MdbDataFileEditor" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="Caption"> @@ -35,9 +47,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.MdbDataFileEditor.Caption" /> string is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption to display on the selection dialog box.</para> + </summary> </Docs> </Member> <Member MemberName="Filter"> @@ -50,10 +68,23 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.MdbDataFileEditor.Filter" /> property is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para> + <para>The <see cref="P:System.Web.UI.Design.MdbDataFileEditor.Filter" /> property default value indicates two URL filters for the dialog box: one for Microsoft Access database files (*.mdb) and another for all files (*.*).</para> + <para>To specify a custom filter string, derive a class from the <see cref="T:System.Web.UI.Design.MdbDataFileEditor" /> class and override the <see cref="P:System.Web.UI.Design.MdbDataFileEditor.Filter" /> property to return the custom filter string.</para> + <para>A filter string contains one or more filter options. Each filter option contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. </para> + <para>The following is an example of a filter string that contains two filter options: </para> + <para>"Microsoft Access Databases (*.mdb)|*.mdb|All Files (*.*)|*.*".</para> + <para>You can specify several filter patterns in a filter option by separating the filter patterns with semicolons. The following is an example of a filter string in which the first filter option specifies two filter patterns: </para> + <para>"Custom Database Files (*.db1; *.db2)|*.db1;*.db2|All Files (*.*)|*.*".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the URL filter options for the editor, which is used to filter the items that appear in the URL selection dialog box.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ReadWriteControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ReadWriteControlDesigner.xml index dd9ae6dd2b1..a60b208e986 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ReadWriteControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ReadWriteControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ReadWriteControlDesigner" FullName="System.Web.UI.Design.ReadWriteControlDesigner"> <TypeSignature Language="C#" Value="public class ReadWriteControlDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,17 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ReadWriteControlDesigner" /> class is obsolete. Use the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + <para>This control designer provides the ability to drop controls onto the control for this designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends design-time behavior for read/write server controls.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +29,16 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ReadWriteControlDesigner" /> class is obsolete. Use the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes an instance of the <see cref="T:System.Web.UI.Design.ReadWriteControlDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,9 +56,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ReadWriteControlDesigner" /> class is obsolete. Use the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the HTML that is used to represent the control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="MapPropertyToStyle"> @@ -54,10 +80,23 @@ <Parameter Name="varPropValue" Type="System.Object" /> </Parameters> <Docs> - <param name="propName">To be added.</param> - <param name="varPropValue">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.ReadWriteControlDesigner.MapPropertyToStyle(System.String,System.Object)" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeCssAttributes" /> method for equivalent control designer functionality.</para> + </block> + <block subset="none" type="note"> + <para>this method must be overridden in a derived class to implement the designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Maps a property, including description and value, to an intrinsic HTML style.</para> + </summary> + <param name="propName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the property to map. </param> + <param name="varPropValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The value of the property. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -72,8 +111,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.ReadWriteControlDesigner.OnBehaviorAttached" /> method is obsolete. Use the members of the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property instead. For example, use the <see cref="M:System.Web.UI.Design.IControlDesignerTag.SetAttribute(System.String,System.String)" /> and <see cref="M:System.Web.UI.Design.IControlDesignerTag.GetAttribute(System.String)" /> methods on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property to map properties to styles.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides notification that is raised when a behavior is attached to the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -96,10 +143,21 @@ <Parameter Name="ce" Type="System.ComponentModel.Design.ComponentChangedEventArgs" /> </Parameters> <Docs> - <param name="sender">To be added.</param> - <param name="ce">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ReadWriteControlDesigner" /> class is obsolete. Use the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + <para>The <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentChanged" /> event occurs after a property has been changed. This method allows implementers to do any processing that may be needed after a property change.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:System.ComponentModel.Design.IComponentChangeService.ComponentChanged" /> event of the <see cref="T:System.ComponentModel.Design.IComponentChangeService" /> class.</para> + </summary> + <param name="sender"> + <attribution license="cc4" from="Microsoft" modified="false" />The object sending the event. </param> + <param name="ce"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.ComponentChangedEventArgs" /> object that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -117,8 +175,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.ReadWriteControlDesigner" /> class is obsolete. Use the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class for equivalent control designer functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Refreshes the display of the control.</para> + </summary> </Docs> </Member> </Members> @@ -127,4 +193,4 @@ <AttributeName>System.Obsolete("Use ContainerControlDesigner instead")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ResourceExpressionEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ResourceExpressionEditor.xml index 5052b6d351d..a0b0073e5e0 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ResourceExpressionEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ResourceExpressionEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ResourceExpressionEditor" FullName="System.Web.UI.Design.ResourceExpressionEditor"> <TypeSignature Language="C#" Value="public class ResourceExpressionEditor : System.Web.UI.Design.ExpressionEditor" /> <AssemblyInfo> @@ -9,9 +10,19 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> class derives from the <see cref="T:System.Web.UI.Design.ExpressionEditor" /> class and provides an implementation for evaluating and associating a resource reference with a control property at design time. For example, you can bind the value of a control property to the resource expression Resources:submitText, which indicates that the control property value is set using the resource named submitText.</para> + <para>A visual designer host, such as vsprvslong, uses the <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> class to specify a resource class, key, and designer default value for a resource expression, and then evaluate the selected resource expression for design-time rendering.</para> + <para>When you browse the <see cref="P:System.Web.UI.Design.HtmlControlDesigner.Expressions" /> property for a control in the design-time properties grid, the visual designer displays a dialog box to set expressions that provide the run-time value for a control property. You can select the expression type based on a list of expression prefixes. When you select the <ui>Resources</ui> expression prefix in the list, the visual designer uses the <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> methods to set, evaluate, and convert the expression based on the resource expression syntax. The visual designer uses the evaluated expression result to assign control property values that are rendered on the design surface.</para> + <para>The base <see cref="P:System.Web.Configuration.ExpressionBuilder.ExpressionPrefix" /> property for a <see cref="T:System.Web.Compilation.ResourceExpressionBuilder" /> returns the string Resources. The <see cref="T:System.Web.Compilation.ResourceExpressionBuilder" /> class is associated with the expression prefix Resources and the <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> implementation.</para> + <para>The <see cref="M:System.Web.UI.Design.ResourceExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method evaluates an input resource expression. The <see cref="M:System.Web.UI.Design.ExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns the <see cref="T:System.Web.UI.Design.ExpressionEditorSheet" /> implementation that is used to select the resource name, class, and designer default value, and to form a resource expression from the selected resource values.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides properties and methods for evaluating and editing a resource expression at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +30,15 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> object is configured by the base class together with an <see cref="P:System.Web.UI.Design.ExpressionEditor.ExpressionPrefix" /> property set to Resources.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of a <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -40,14 +57,26 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="parseTimeData">To be added.</param> - <param name="propertyType">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ResourceExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method looks up the resource that is specified by <paramref name="expression" />, and then returns the resource.</para> + <para>The visual designer uses the <see cref="M:System.Web.UI.Design.ResourceExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method to evaluate a resource expression and provide the design-time value for an associated control property. At run time, the page parser uses the <see cref="M:System.Web.Compilation.ResourceExpressionBuilder.EvaluateExpression(System.Object,System.Web.UI.BoundPropertyEntry,System.Object,System.Web.Compilation.ExpressionBuilderContext)" /> and <see cref="M:System.Web.Compilation.ResourceExpressionBuilder.GetCodeExpression(System.Web.UI.BoundPropertyEntry,System.Object,System.Web.Compilation.ExpressionBuilderContext)" /> methods of the corresponding <see cref="T:System.Web.Compilation.ResourceExpressionBuilder" /> implementation to evaluate an expression and provide the run-time value for an associated control property.</para> + <para>The visual designer uses the <see cref="M:System.Web.Compilation.ResourceExpressionBuilder.ParseExpression(System.String)" /> method to parse the expression string at design time, and then calls the <see cref="M:System.Web.UI.Design.ResourceExpressionEditor.EvaluateExpression(System.String,System.Object,System.Type,System.IServiceProvider)" /> method with the parsed expression data.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Evaluates a resource expression and provides the design-time value for a control property.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />A resource expression to evaluate. <paramref name="expression" /> does not include the Resources expression prefix.</param> + <param name="parseTimeData"> + <attribution license="cc4" from="Microsoft" modified="false" />An object supplying additional parse data, in the form of a <see cref="T:System.Web.Compilation.ResourceExpressionFields" /> value.</param> + <param name="propertyType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the control property.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -64,16 +93,24 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version=".NET 2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ResourceExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns an expression editor sheet implementation for resource expressions. The visual designer host uses the expression editor sheet in its expressions dialog box. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a resource expression editor sheet that is initialized with the input expression string and service provider implementation.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />A resource expression, used to initialize the expression editor sheet.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to initialize the expression editor sheet.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ResourceExpressionEditorSheet.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ResourceExpressionEditorSheet.xml index 19f7866a068..dfaf4d32755 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ResourceExpressionEditorSheet.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ResourceExpressionEditorSheet.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ResourceExpressionEditorSheet" FullName="System.Web.UI.Design.ResourceExpressionEditorSheet"> <TypeSignature Language="C#" Value="public class ResourceExpressionEditorSheet : System.Web.UI.Design.ExpressionEditorSheet" /> <AssemblyInfo> @@ -9,8 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The visual designer uses the <see cref="T:System.Web.UI.Design.ResourceExpressionEditor" /> class with the <see cref="T:System.Web.UI.Design.ResourceExpressionEditorSheet" /> class to select the individual properties of a resource reference expression, and to combine the selected resource expression property values into a resource expression.</para> + <para>The <see cref="M:System.Web.UI.Design.ConnectionStringsExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method returns a <see cref="T:System.Web.UI.Design.ResourceExpressionEditorSheet" /> object. In the expressions dialog box, when you select a control property and bind it to a resource expression, the visual designer calls the <see cref="M:System.Web.UI.Design.ResourceExpressionEditor.GetExpressionEditorSheet(System.String,System.IServiceProvider)" /> method. The visual designer uses the returned <see cref="T:System.Web.UI.Design.ResourceExpressionEditorSheet" /> object to prompt for the <see cref="P:System.Web.UI.Design.ResourceExpressionEditorSheet.ClassKey" /> and <see cref="P:System.Web.UI.Design.ResourceExpressionEditorSheet.ResourceKey" /> properties. Once the resource expression properties are selected, the visual designer calls the <see cref="M:System.Web.UI.Design.ResourceExpressionEditorSheet.GetExpression" /> method to combine the properties into a resource expression string.</para> + <para>The <see cref="P:System.Web.UI.Design.ResourceExpressionEditorSheet.ResourceKey" /> property must be specified in a resource expression; it indexes the resource value. The <see cref="P:System.Web.UI.Design.ResourceExpressionEditorSheet.ClassKey" /> property is optional. It references the class key or file name that defines the resource in the global resources folder.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a design-time editor sheet for the properties of a resource expression in the UI of a designer host at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +33,18 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="expression">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The initial <see cref="P:System.Web.UI.Design.ResourceExpressionEditorSheet.ClassKey" /> and <see cref="P:System.Web.UI.Design.ResourceExpressionEditorSheet.ResourceKey" /> property values are set using the input <paramref name="expression" /> string. The <see cref="P:System.Web.UI.Design.ExpressionEditorSheet.ServiceProvider" /> property is set using the input <paramref name="serviceProvider" /> implementation.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ResourceExpressionEditorSheet" /> class.</para> + </summary> + <param name="expression"> + <attribution license="cc4" from="Microsoft" modified="false" />A resource expression, used to initialize the expression editor sheet.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider implementation supplied by the designer host, used to obtain additional design-time services.</param> </Docs> </Member> <Member MemberName="ClassKey"> @@ -45,9 +62,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>In vsprvslong, global resource files are located in the App_GlobalResources folder.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the key that matches the filename for the resource in the project's global resource folder.</para> + </summary> </Docs> </Member> <Member MemberName="GetExpression"> @@ -61,9 +84,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a resource expression that is formed by the expression editor sheet property values.</para> + </summary> </Docs> </Member> <Member MemberName="IsValid"> @@ -76,9 +102,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This base implementation always returns true.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the resource expression string is valid.</para> + </summary> </Docs> </Member> <Member MemberName="ResourceKey"> @@ -96,10 +128,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ResourceExpressionEditorSheet.ResourceKey" /> property is required for a resource expression; it indicates the name of the resource. The name of the resource is used at both run time and design time to look up a resource and assign it to a control property.</para> + <para>For example, if the <see cref="P:System.Web.UI.WebControls.Label.Text" /> property for a <see cref="T:System.Web.UI.WebControls.Label" /> control is assigned to the resource expression <%$ Resources:Strings, labelText $>, the resource expression is evaluated and the <see cref="P:System.Web.UI.WebControls.Label.Text" /> field is assigned to the labelText resource value in the Strings class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the name of the resource, which is used as a key to find the resource value.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/SkinIDTypeConverter.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/SkinIDTypeConverter.xml index 70bd49d06ab..29704696a6a 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/SkinIDTypeConverter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/SkinIDTypeConverter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="SkinIDTypeConverter" FullName="System.Web.UI.Design.SkinIDTypeConverter"> <TypeSignature Language="C#" Value="public class SkinIDTypeConverter : System.ComponentModel.TypeConverter" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a list of valid skin IDs for a control at design time, based on the currently applicable theme.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.SkinIDTypeConverter" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="CanConvertFrom"> @@ -39,11 +46,16 @@ <Parameter Name="sourceType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="sourceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value indicating whether this converter can convert a <see cref="P:System.Web.UI.Control.SkinID" /> object to a string using the provided format context and type.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An T:System.ComponentModel.ITypeDescriptorContext that provides a format context for the control being designed.</param> + <param name="sourceType"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Type" />.</param> </Docs> </Member> <Member MemberName="CanConvertTo"> @@ -60,11 +72,16 @@ <Parameter Name="destType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="destType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value indicating whether this converter can convert a <see cref="P:System.Web.UI.Control.SkinID" /> object to the specified type, using the specified context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An T:System.ComponentModel.ITypeDescriptorContext that provides a format context for the control being designed.</param> + <param name="destType"> + <attribution license="cc4" from="Microsoft" modified="false" />A T:System.Type that represents the type to convert to.</param> </Docs> </Member> <Member MemberName="ConvertFrom"> @@ -82,12 +99,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the given string to a <see cref="P:System.Web.UI.Control.SkinID" /> object using the specified context and culture information.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An T:System.ComponentModel.ITypeDescriptorContext that provides a format context that represents the control being designed.</param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />A T:System.Globalization.CultureInfo. If null is passed, the current culture is assumed.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The string to convert.</param> </Docs> </Member> <Member MemberName="ConvertTo"> @@ -106,13 +129,20 @@ <Parameter Name="destinationType" Type="System.Type" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="culture">To be added.</param> - <param name="value">To be added.</param> - <param name="destinationType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the given <see cref="P:System.Web.UI.Control.SkinID" /> object to a string using the specified context and culture information.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An T:System.ComponentModel.ITypeDescriptorContext that provides a format context that represents the control being designed.</param> + <param name="culture"> + <attribution license="cc4" from="Microsoft" modified="false" />A T:System.Globalization.CultureInfo. If null, the current culture is assumed. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:System.Web.UI.Control.SkinID" /> object to convert.</param> + <param name="destinationType"> + <attribution license="cc4" from="Microsoft" modified="false" />The T:System.Type to convert <paramref name="value" /> to (must be a <see cref="T:System.String" />). </param> </Docs> </Member> <Member MemberName="GetStandardValues"> @@ -128,10 +158,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a set of <see cref="P:System.Web.UI.Control.SkinID" /> objects that can be applied to the control that is represented by the given format context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An T:System.ComponentModel.ITypeDescriptorContext that provides a format context that represents the control being designed. <paramref name="context" /> or properties of <paramref name="context" /> can be null.</param> </Docs> </Member> <Member MemberName="GetStandardValuesSupported"> @@ -147,11 +181,15 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value indicating whether the control that is represented by the given context supports a set of <see cref="P:System.Web.UI.Control.SkinID" /> objects that can be picked from a list.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> for the control being designed.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/SupportsPreviewControlAttribute.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/SupportsPreviewControlAttribute.xml index c0bd460a4b9..8264816d38e 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/SupportsPreviewControlAttribute.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/SupportsPreviewControlAttribute.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="SupportsPreviewControlAttribute" FullName="System.Web.UI.Design.SupportsPreviewControlAttribute"> <TypeSignature Language="C#" Value="public sealed class SupportsPreviewControlAttribute : Attribute" /> <AssemblyInfo> @@ -14,8 +15,23 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Apply the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute to a control designer class to indicate the type of preview control that is supported by the control designer. Use this attribute to change a preview control for design-time rendering without affecting the actual persisted instance of the associated control.</para> + <para>Typically, you specify the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> when declaring a custom designer class that is derived from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class. The value of the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property for the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute determines the behavior for the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> and <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> members in the base <see cref="T:System.Web.UI.Design.ControlDesigner" /> class. </para> + <para>Set the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property to true to indicate that the designer uses a temporary copy of the associated control to generate the design-time HTML. Changes to the temporary control are not persisted. </para> + <para>Set the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property to false to indicate that the designer returns the control instance, specifically the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Component" /> property, from the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> method. Changes to the control object are persisted. </para> + <para>For example, the <see cref="T:System.Web.UI.Design.WebControls.CalendarDesigner" /> class is marked with the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> set to true. The designer uses the preview control with the automatic style formatting task, which allows the user to preview various autoformat styles that can be applied to the calendar. As the user selects different autoformat styles in the user interface, the selected style scheme is applied to the preview control. Applying a new style to the preview control does not change the scheme that is applied to the instance of the <see cref="T:System.Web.UI.WebControls.Calendar" /> control in the designer.</para> + <para>If the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> is not specified in the control designer declaration, the <see cref="T:System.Web.UI.Design.ControlDesigner" /> behavior is equivalent to specifying the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> as false.</para> + <block subset="none" type="note"> + <para>Designer classes derived from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class can override the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> and <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> members, and ignore the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute. To determine the expected behavior for <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> and <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" />, see the reference documentation for the derived control designer class.</para> + </block> + <para>For general information about using attributes, see <format type="text/html"><a href="a4daf212-2410-423d-a800-7a08864e9bff">Attributes Overview</a></format> and <format type="text/html"><a href="30386922-1e00-4602-9ebf-526b271a8b87">Extending Metadata Using Attributes</a></format>. For more information about design-time attributes, see <format type="text/html"><a href="7aed9eb4-124b-4a15-a0a3-458f37ac9ef7">Attributes and Design-Time Support</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether a control designer requires a preview instance of the control at design time. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -28,9 +44,16 @@ <Parameter Name="supportsPreviewControl" Type="System.Boolean" /> </Parameters> <Docs> - <param name="supportsPreviewControl">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Typically, you do not need to create an instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class directly. Apply the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> to the class declaration of the custom control designer in the source code.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class and sets the initial value of the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property.</para> + </summary> + <param name="supportsPreviewControl"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial value to assign for <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" />.</param> </Docs> </Member> <Member MemberName="Default"> @@ -43,8 +66,15 @@ <ReturnType>System.Web.UI.Design.SupportsPreviewControlAttribute</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property of the <see cref="F:System.Web.UI.Design.SupportsPreviewControlAttribute.Default" /> field is set to false.</para> + <para>Use the <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.IsDefaultAttribute" /> method to determine whether the value for the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property is set to the default preview value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class that is set to the default preview value. This field is read-only.</para> + </summary> </Docs> </Member> <Member MemberName="Equals"> @@ -60,10 +90,18 @@ <Parameter Name="obj" Type="System.Object" /> </Parameters> <Docs> - <param name="obj">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.Equals(System.Object)" /> method overrides the <see cref="M:System.Object.Equals(System.Object)" /> method.</para> + <para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.Equals(System.Object)" /> method compares two instances based on the value of their <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> properties.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the specified object represents the same preview attribute setting as the current instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class.</para> + </summary> + <param name="obj"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to compare with the current instance of <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" />.</param> </Docs> </Member> <Member MemberName="GetHashCode"> @@ -77,9 +115,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.GetHashCode" /> method overrides the <see cref="M:System.Object.GetHashCode" /> method.</para> + <para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.GetHashCode" /> method generates the same hash code for two objects that are equal according to the <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.Equals(System.Object)" /> method. The hash code is suitable for use in hashing algorithms and data structures, such as hash tables.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the hash code for this instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="IsDefaultAttribute"> @@ -93,9 +138,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.IsDefaultAttribute" /> method compares the value for the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property of the current <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> object with the value for the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property of the static <see cref="F:System.Web.UI.Design.SupportsPreviewControlAttribute.Default" /> field.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the current instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class is set to the default preview attribute value.</para> + </summary> </Docs> </Member> <Member MemberName="SupportsPreviewControl"> @@ -108,10 +159,18 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Typically, you specify a value for the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property by applying the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute to a custom designer class declaration. The value of the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property for the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute determines the behavior for the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> and <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> members in the base <see cref="T:System.Web.UI.Design.ControlDesigner" /> class.</para> + <para>Set the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property to true to indicate that the designer uses a temporary copy of the associated control to generate the design-time HTML. Changes to the temporary control are not persisted. </para> + <para>Set the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property to false to indicate that the designer returns the control instance, specifically the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Component" /> property, from the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> method. Changes to the control object are persisted.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the control designer requires a temporary preview control at design time.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateDefinition.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateDefinition.xml index 172cac1ef75..77debea0069 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateDefinition.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateDefinition.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TemplateDefinition" FullName="System.Web.UI.Design.TemplateDefinition"> <TypeSignature Language="C#" Value="public class TemplateDefinition : System.Web.UI.Design.DesignerObject" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.TemplateDefinition" /> class provides a base template definition class that can be inherited from and extended for a control designer to use in providing support for templated controls in a design host such as vsprvslong. A design host uses the properties and methods of the <see cref="T:System.Web.UI.Design.TemplateDefinition" /> class to facilitate creating and editing a template at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides properties and methods that define a template element in a Web server control at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -26,12 +33,19 @@ <Parameter Name="templatePropertyName" Type="System.String" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="name">To be added.</param> - <param name="templatedObject">To be added.</param> - <param name="templatePropertyName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateDefinition" /> class, using the provided designer, template name, template, and property name.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent <see cref="T:System.Web.UI.Design.ControlDesigner" /> object.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the template.</param> + <param name="templatedObject"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that contains the template.</param> + <param name="templatePropertyName"> + <attribution license="cc4" from="Microsoft" modified="false" />The property name that represents this template in the <ui>Properties</ui> list in the design host.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -48,13 +62,21 @@ <Parameter Name="serverControlsOnly" Type="System.Boolean" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="name">To be added.</param> - <param name="templatedObject">To be added.</param> - <param name="templatePropertyName">To be added.</param> - <param name="serverControlsOnly">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateDefinition" /> class, using the provided designer, template name, template, property name, and whether to limit the template contents to Web server controls.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent <see cref="T:System.Web.UI.Design.ControlDesigner" /> object.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the template.</param> + <param name="templatedObject"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that contains the template.</param> + <param name="templatePropertyName"> + <attribution license="cc4" from="Microsoft" modified="false" />The property name that represents this template in the <ui>Properties</ui> list in the design host.</param> + <param name="serverControlsOnly"> + <attribution license="cc4" from="Microsoft" modified="false" />A Boolean value indicating whether the template content should allow only Web server controls.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -71,13 +93,21 @@ <Parameter Name="style" Type="System.Web.UI.WebControls.Style" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="name">To be added.</param> - <param name="templatedObject">To be added.</param> - <param name="templatePropertyName">To be added.</param> - <param name="style">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateDefinition" /> class, using the provided designer, template name, template, property name, and <see cref="T:System.Web.UI.WebControls.Style" /> object.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent <see cref="T:System.Web.UI.Design.ControlDesigner" /> object.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the template.</param> + <param name="templatedObject"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that contains the template.</param> + <param name="templatePropertyName"> + <attribution license="cc4" from="Microsoft" modified="false" />The property name that represents this template in the <ui>Properties</ui> list in the design host.</param> + <param name="style"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.Style" /> object to apply to each template.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -95,14 +125,23 @@ <Parameter Name="serverControlsOnly" Type="System.Boolean" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="name">To be added.</param> - <param name="templatedObject">To be added.</param> - <param name="templatePropertyName">To be added.</param> - <param name="style">To be added.</param> - <param name="serverControlsOnly">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateDefinition" /> class, using the provided designer, template name, template, property name, <see cref="T:System.Web.UI.WebControls.Style" /> object, and whether to limit content to Web server controls.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The parent <see cref="T:System.Web.UI.Design.ControlDesigner" /> object.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the template.</param> + <param name="templatedObject"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that contains the template.</param> + <param name="templatePropertyName"> + <attribution license="cc4" from="Microsoft" modified="false" />The property name that represents this template in the <ui>Properties</ui> list in the design host.</param> + <param name="style"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.Style" /> object to apply to each template.</param> + <param name="serverControlsOnly"> + <attribution license="cc4" from="Microsoft" modified="false" />A Boolean value indicating whether the template should limit content to Web server controls.</param> </Docs> </Member> <Member MemberName="AllowEditing"> @@ -115,9 +154,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>To change the default, derived classes must override the <see cref="P:System.Web.UI.Design.TemplateDefinition.AllowEditing" /> property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the template should enable editing of its contents.</para> + </summary> </Docs> </Member> <Member MemberName="Content"> @@ -130,9 +175,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the HTML markup representing the content of the template.</para> + </summary> </Docs> </Member> <Member MemberName="ServerControlsOnly"> @@ -145,9 +193,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves a value indicating whether the template should limit content to Web server controls, as set in the <see cref="Overload:System.Web.UI.Design.TemplateDefinition.#ctor" /> constructor. This property is read-only.</para> + </summary> </Docs> </Member> <Member MemberName="Style"> @@ -160,9 +211,15 @@ <ReturnType>System.Web.UI.WebControls.Style</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Although the <see cref="T:System.Web.UI.WebControls.Style" /> property is read-only, the properties of the <see cref="T:System.Web.UI.WebControls.Style" /> can be set.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the style that should be applied to the template as set in the <see cref="Overload:System.Web.UI.Design.TemplateDefinition.#ctor" /> constructor. This property is read-only.</para> + </summary> </Docs> </Member> <Member MemberName="SupportsDataBinding"> @@ -175,9 +232,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves or sets a value indicating whether the template supports data binding.</para> + </summary> </Docs> </Member> <Member MemberName="TemplatedObject"> @@ -190,9 +250,15 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Although this <see cref="P:System.Web.UI.Design.TemplateDefinition.TemplatedObject" /> property is read-only, its properties can be set, and if <see cref="P:System.Web.UI.Design.TemplateDefinition.AllowEditing" /> is true, the content can be edited.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the component in which the template resides. This property is read-only.</para> + </summary> </Docs> </Member> <Member MemberName="TemplatePropertyName"> @@ -205,10 +271,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the property name for the template that the design host should display in the property grid.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateEditingService.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateEditingService.xml index 46b0ef4817a..283c9d6f827 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateEditingService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateEditingService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TemplateEditingService" FullName="System.Web.UI.Design.TemplateEditingService"> <TypeSignature Language="C#" Value="public sealed class TemplateEditingService : IDisposable, System.Web.UI.Design.ITemplateEditingService" /> <AssemblyInfo> @@ -17,8 +18,16 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingService" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> object for each <see cref="T:System.Web.UI.Design.TemplateDefinition" /> in each <see cref="T:System.Web.UI.Design.TemplateGroup" /> that is defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides services for editing control templates at design time. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -28,9 +37,18 @@ <Parameter Name="designerHost" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingService" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> object for each <see cref="T:System.Web.UI.Design.TemplateDefinition" /> in each <see cref="T:System.Web.UI.Design.TemplateGroup" /> that is defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateEditingService" /> class with the specified designer host. </para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.Design.IDesignerHost" /> implementation, used to access components at design time.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -49,12 +67,23 @@ <Parameter Name="templateNames" Type="System.String[]" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="frameName">To be added.</param> - <param name="templateNames">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingService" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> object for each <see cref="T:System.Web.UI.Design.TemplateDefinition" /> in each <see cref="T:System.Web.UI.Design.TemplateGroup" /> that is defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new template editing frame for the specified templated control designer, using the specified name and templates.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> that will use the template editing frame.</param> + <param name="frameName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the editing frame that will be displayed on the frame. Typically, this is the same as the <see cref="P:System.ComponentModel.Design.DesignerVerb.Text" /> used as the menu text for the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> that is invoked to create the frame.</param> + <param name="templateNames"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of names for the templates that the template editing frame will contain.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -75,14 +104,27 @@ <Parameter Name="templateStyles" Type="System.Web.UI.WebControls.Style[]" /> </Parameters> <Docs> - <param name="designer">To be added.</param> - <param name="frameName">To be added.</param> - <param name="templateNames">To be added.</param> - <param name="controlStyle">To be added.</param> - <param name="templateStyles">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingService" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> object for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> that is defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new template editing frame for the specified <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> object, using the specified name, template names, control style, and template styles.</para> + </summary> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> that will use the template editing frame. </param> + <param name="frameName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the editing frame that will be displayed on the frame. Typically, this is the same as the <see cref="P:System.ComponentModel.Design.DesignerVerb.Text" /> used as the menu text for the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> that is invoked to create the frame. </param> + <param name="templateNames"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of names for the templates that the template editing frame will contain. </param> + <param name="controlStyle"> + <attribution license="cc4" from="Microsoft" modified="false" />The control <see cref="T:System.Web.UI.WebControls.Style" /> for the editing frame. </param> + <param name="templateStyles"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Web.UI.WebControls.Style" /> that represents the template styles for the editing frame. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -97,8 +139,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases all resources that are used by the <see cref="T:System.Web.UI.Design.TemplateEditingService" /> object. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -131,10 +176,19 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para> The <see cref="T:System.Web.UI.Design.TemplateEditingService" /> class is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplatedEditableDesignerRegion.TemplateDefinition" /> property of the <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> class for equivalent design-time functionality.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the parent template.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> for which to get the name of the parent template. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -148,9 +202,18 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingService" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> object for each <see cref="T:System.Web.UI.Design.TemplateDefinition" /> in each <see cref="T:System.Web.UI.Design.TemplateGroup" /> that is defined for a control designer.</para> + </block> + <para>The <see cref="P:System.Web.UI.Design.TemplateEditingService.SupportsNestedTemplateEditing" /> property indicates whether a template editor can be invoked from a component of a parent template editor's templated control. This is called nested template editing, because a template editor is invoked for a component of a control for which a template editor is already operating.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value that indicates whether the service supports nested template editing.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -163,4 +226,4 @@ <AttributeName>System.Obsolete("Template editing is supported in ControlDesigner.TemplateGroups with SetViewFlags(ViewFlags.TemplateEditing, true) in 2.0.")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateEditingVerb.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateEditingVerb.xml index edb283c8476..951237f3797 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateEditingVerb.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateEditingVerb.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TemplateEditingVerb" FullName="System.Web.UI.Design.TemplateEditingVerb"> <TypeSignature Language="C#" Value="public class TemplateEditingVerb : System.ComponentModel.Design.DesignerVerb, IDisposable" /> <AssemblyInfo> @@ -14,8 +15,16 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a designer verb that creates a template editing frame, and that can be invoked only by a template editor.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -29,10 +38,20 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="text">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class with the specified verb text and index.</para> + </summary> + <param name="text"> + <attribution license="cc4" from="Microsoft" modified="false" />The text to show for the verb on a menu.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />An optional integer value that can be used by a designer, typically to indicate the index of the verb within a set of verbs.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -44,11 +63,22 @@ <Parameter Name="designer" Type="System.Web.UI.Design.TemplatedControlDesigner" /> </Parameters> <Docs> - <param name="text">To be added.</param> - <param name="index">To be added.</param> - <param name="designer">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class.</para> + </summary> + <param name="text"> + <attribution license="cc4" from="Microsoft" modified="false" />The text to show for the verb on a menu. </param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />An optional integer value that can be used by a designer, typically to indicate the index of the verb within a set of verbs. </param> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> that can use this verb. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -63,8 +93,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Calling <see cref="M:System.Web.UI.Design.TemplateEditingVerb.Dispose" /> allows the resources used by the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> to be reallocated for other purposes. </para> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases all resources used by the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -81,9 +120,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose method and the <see cref="M:System.Object.Finalize" /> method. Dispose invokes the protected Dispose(Boolean) method with <paramref name="disposing" /> set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When <paramref name="disposing" /> is true, this method releases all resources held by any managed objects that this <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> references. This method invokes the Dispose method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -98,8 +145,19 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method overrides <see cref="M:System.Object.Finalize" /> and cleans up resources by calling Dispose(false). Override Dispose(Boolean) to customize the cleanup.</para> + <para>Application code should not call this method; an object's Finalize method is automatically invoked during garbage collection, unless finalization by the garbage collector has been disabled by a call to the <see cref="M:System.GC.SuppressFinalize(System.Object)" /> method.</para> + <para>For more information, see <format type="text/html"><a href="FD376774-1643-499B-869E-9546A3AEEA70">[<topic://cpconFinalizeMethodscDestructors>]</a></format>, <format type="text/html"><a href="a17b0066-71c2-4ba4-9822-8e19332fc213">Cleaning Up Unmanaged Resources</a></format>, and <format type="text/html"><a href="8026CB68-FE93-43FC-96C1-C09AD7D64CD3">[<topic://cpconOverridingFinalizeMethod>]</a></format>.</para> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Attempts to free resources before the object is reclaimed by garbage collection.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -113,9 +171,18 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This property is sometimes used to store the index of each verb in a set of verbs. When implementing a custom designer, this property can be used to store custom-defined integer data.</para> + <block subset="none" type="note"> + <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the index or other user data for the verb.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -128,4 +195,4 @@ <AttributeName>System.Obsolete("Template editing is supported in ControlDesigner.TemplateGroups with SetViewFlags(ViewFlags.TemplateEditing, true) in 2.0.")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateGroup.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateGroup.xml index ee98f1b9b8d..29fb3d919ce 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateGroup.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateGroup.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TemplateGroup" FullName="System.Web.UI.Design.TemplateGroup"> <TypeSignature Language="C#" Value="public class TemplateGroup" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A collection of <see cref="T:System.Web.UI.Design.TemplateDefinition" /> objects representing the template elements in a Web server control at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +27,13 @@ <Parameter Name="groupName" Type="System.String" /> </Parameters> <Docs> - <param name="groupName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateGroup" /> class, using the provided name.</para> + </summary> + <param name="groupName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the group.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -39,10 +47,15 @@ <Parameter Name="groupStyle" Type="System.Web.UI.WebControls.Style" /> </Parameters> <Docs> - <param name="groupName">To be added.</param> - <param name="groupStyle">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateGroup" /> class, using the provided name and style.</para> + </summary> + <param name="groupName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the group</param> + <param name="groupStyle"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.Style" /> object to be applied to templates in the group.</param> </Docs> </Member> <Member MemberName="AddTemplateDefinition"> @@ -58,9 +71,13 @@ <Parameter Name="templateDefinition" Type="System.Web.UI.Design.TemplateDefinition" /> </Parameters> <Docs> - <param name="templateDefinition">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the provided <see cref="T:System.Web.UI.Design.TemplateDefinition" /> to the group.</para> + </summary> + <param name="templateDefinition"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.TemplateDefinition" />.</param> </Docs> </Member> <Member MemberName="GroupName"> @@ -73,9 +90,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the group.</para> + </summary> </Docs> </Member> <Member MemberName="GroupStyle"> @@ -88,9 +108,12 @@ <ReturnType>System.Web.UI.WebControls.Style</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the current style for the group.</para> + </summary> </Docs> </Member> <Member MemberName="IsEmpty"> @@ -103,9 +126,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether there are any templates in the group.</para> + </summary> </Docs> </Member> <Member MemberName="Templates"> @@ -118,10 +144,13 @@ <ReturnType>System.Web.UI.Design.TemplateDefinition[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array of all template definitions in the group.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateGroupCollection.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateGroupCollection.xml index 93d41c12e2c..b580ae3fc54 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateGroupCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateGroupCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TemplateGroupCollection" FullName="System.Web.UI.Design.TemplateGroupCollection"> <TypeSignature Language="C#" Value="public sealed class TemplateGroupCollection : System.Collections.IList" /> <AssemblyInfo> @@ -13,8 +14,46 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class, and any derived class, defines the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property as a <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> object. The <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> property is typically used only by a design host such as vsprvslong.</para> + <para>The collection dynamically increases in size as objects are added. Indexes in this collection are zero-based. Use the <see cref="P:System.Web.UI.Design.TemplateGroupCollection.Count" /> property to determine how many groups are in the collection.</para> + <para>Additionally, use the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> methods and properties to provide the following functionality: </para> + <list type="bullet"> + <item> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Add(System.Web.UI.Design.TemplateGroup)" /> method to add a single group to the collection. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Insert(System.Int32,System.Web.UI.Design.TemplateGroup)" /> method to add a group at a particular index within the collection. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Remove(System.Web.UI.Design.TemplateGroup)" /> method to remove a group. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.RemoveAt(System.Int32)" /> method to remove the group at a particular index.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Contains(System.Web.UI.Design.TemplateGroup)" /> method to determine whether a particular group is already in the collection. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.IndexOf(System.Web.UI.Design.TemplateGroup)" /> method to retrieve the index of a group within the collection. </para> + </item> + <item> + <para>The <see cref="P:System.Web.UI.Design.TemplateGroupCollection.Item(System.Int32)" /> indexer to get or set the group at a particular index, using array notation.</para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.AddRange(System.Web.UI.Design.TemplateGroupCollection)" /> method to add multiple groups to the collection. </para> + <para>You can add multiple groups either as an array of groups or as a <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> object that you retrieve through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of another control designer. </para> + </item> + <item> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Clear" /> method to remove all groups from the collection.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a collection of <see cref="T:System.Web.UI.Design.TemplateGroup" /> objects within a control designer. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,8 +64,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.#ctor" /> constructor to create an empty collection. You can add elements to the collection by using the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Add(System.Web.UI.Design.TemplateGroup)" />, <see cref="M:System.Web.UI.Design.TemplateGroupCollection.AddRange(System.Web.UI.Design.TemplateGroupCollection)" />, or <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Insert(System.Int32,System.Web.UI.Design.TemplateGroup)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Add"> @@ -42,10 +87,18 @@ <Parameter Name="group" Type="System.Web.UI.Design.TemplateGroup" /> </Parameters> <Docs> - <param name="group">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Add(System.Web.UI.Design.TemplateGroup)" /> method adds the specified <see cref="T:System.Web.UI.Design.TemplateGroup" /> object to the end of the collection. To add a <see cref="T:System.Web.UI.Design.TemplateGroup" /> object to the collection at a specific index location, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Insert(System.Int32,System.Web.UI.Design.TemplateGroup)" /> method.</para> + <para>To add multiple groups to the collection, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.AddRange(System.Web.UI.Design.TemplateGroupCollection)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the specified <see cref="T:System.Web.UI.Design.TemplateGroup" /> object to the end of the collection.</para> + </summary> + <param name="group"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplateGroup" /> to add to the collection.</param> </Docs> </Member> <Member MemberName="AddRange"> @@ -61,9 +114,16 @@ <Parameter Name="groups" Type="System.Web.UI.Design.TemplateGroupCollection" /> </Parameters> <Docs> - <param name="groups">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.AddRange(System.Web.UI.Design.TemplateGroupCollection)" /> method adds multiple groups to the collection. To add a single <see cref="T:System.Web.UI.Design.TemplateGroup" /> object to the end of the collection, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Add(System.Web.UI.Design.TemplateGroup)" /> method. To add a <see cref="T:System.Web.UI.Design.TemplateGroup" /> object to the collection at a specific index location, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Insert(System.Int32,System.Web.UI.Design.TemplateGroup)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the template groups in an existing <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> object to the current <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> object.</para> + </summary> + <param name="groups"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> that contains the groups to add to the collection.</param> </Docs> </Member> <Member MemberName="Clear"> @@ -77,8 +137,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Clear" /> method to remove all groups from the collection. To remove a specific group from the collection, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Remove(System.Web.UI.Design.TemplateGroup)" /> method. To remove a group at a particular index, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.RemoveAt(System.Int32)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes all groups from the collection.</para> + </summary> </Docs> </Member> <Member MemberName="Contains"> @@ -94,10 +160,18 @@ <Parameter Name="group" Type="System.Web.UI.Design.TemplateGroup" /> </Parameters> <Docs> - <param name="group">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Contains(System.Web.UI.Design.TemplateGroup)" /> method determines equality by using the <see cref="M:System.Object.Equals(System.Object)" /> method on the <see cref="T:System.Web.UI.Design.TemplateGroup" /> objects.</para> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Contains(System.Web.UI.Design.TemplateGroup)" /> method performs a linear search; therefore, the average execution time is proportional to the <see cref="P:System.Web.UI.Design.TemplateGroupCollection.Count" /> property. Because template group collections typically are small, the performance of the linear search operation is not critical.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the specified group is contained within the collection.</para> + </summary> + <param name="group"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplateGroup" /> to locate within the collection.</param> </Docs> </Member> <Member MemberName="CopyTo"> @@ -114,10 +188,18 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The group elements are copied to the <see cref="T:System.Array" /> object in the same order in which the group elements are indexed within the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the groups in the collection to a compatible one-dimensional array, starting at the specified index of the target array.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Array" /> that is the destination of the copied groups. The <see cref="T:System.Array" /> must have zero-based indexing.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param> </Docs> </Member> <Member MemberName="Count"> @@ -130,9 +212,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.TemplateGroupCollection.Count" /> property generally is used to determine the upper boundary index when iterating through objects in the collection. Because the collection indexes are zero-based, the first element is at index 0 and the last element is at index Count-1.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of <see cref="T:System.Web.UI.Design.TemplateGroup" /> objects in the collection.</para> + </summary> </Docs> </Member> <Member MemberName="IndexOf"> @@ -148,10 +236,18 @@ <Parameter Name="group" Type="System.Web.UI.Design.TemplateGroup" /> </Parameters> <Docs> - <param name="group">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.IndexOf(System.Web.UI.Design.TemplateGroup)" /> method determines equality by using the <see cref="M:System.Object.Equals(System.Object)" /> method on the <see cref="T:System.Web.UI.Design.TemplateGroup" /> objects.</para> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.IndexOf(System.Web.UI.Design.TemplateGroup)" /> performs a linear search; therefore, the average execution time is proportional to the <see cref="P:System.Web.UI.Design.TemplateGroupCollection.Count" /> property. Because template group collections typically are small, the performance of the linear search operation is not critical.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the index of the specified <see cref="T:System.Web.UI.Design.TemplateGroup" /> object within the collection.</para> + </summary> + <param name="group"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplateGroup" /> to locate within the collection.</param> </Docs> </Member> <Member MemberName="Insert"> @@ -168,10 +264,21 @@ <Parameter Name="group" Type="System.Web.UI.Design.TemplateGroup" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="group">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Insert(System.Int32,System.Web.UI.Design.TemplateGroup)" /> method adds a <see cref="T:System.Web.UI.Design.TemplateGroup" /> object to the collection at a specific index location. To add a single <see cref="T:System.Web.UI.Design.TemplateGroup" /> to the end of the collection, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Add(System.Web.UI.Design.TemplateGroup)" /> method. To add multiple groups to the collection, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.AddRange(System.Web.UI.Design.TemplateGroupCollection)" /> method.</para> + <block subset="none" type="note"> + <para>When you insert an item into the collection, the indexes change for subsequent items in the collection.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts a <see cref="T:System.Web.UI.Design.TemplateGroup" /> object into the collection at the specified index.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index within the collection at which to insert <paramref name="group" />.</param> + <param name="group"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplateGroup" /> to insert into the collection.</param> </Docs> </Member> <Member MemberName="Item"> @@ -206,9 +313,22 @@ <Parameter Name="group" Type="System.Web.UI.Design.TemplateGroup" /> </Parameters> <Docs> - <param name="group">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Remove(System.Web.UI.Design.TemplateGroup)" /> method removes the first occurrence of <paramref name="group" /> from the collection. If the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> object does not contain <paramref name="group" />, the collection remains unchanged. No exception is thrown.</para> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Remove(System.Web.UI.Design.TemplateGroup)" /> method determines equality by using the <see cref="M:System.Object.Equals(System.Object)" /> method on the <see cref="T:System.Web.UI.Design.TemplateGroup" /> objects.</para> + <para>The <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Remove(System.Web.UI.Design.TemplateGroup)" /> method performs a linear search; therefore, the average execution time is proportional to the <see cref="P:System.Web.UI.Design.TemplateGroupCollection.Count" /> property. Because template group collections typically are small, the performance of the linear search operation is not critical.</para> + <para>To remove a group at a particular index from the collection, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.RemoveAt(System.Int32)" /> method. To remove all the groups from the collection, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Clear" /> method.</para> + <block subset="none" type="note"> + <para>When you remove an item from the collection, the indexes change for subsequent items in the collection.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified <see cref="T:System.Web.UI.Design.TemplateGroup" /> object from the collection. </para> + </summary> + <param name="group"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplateGroup" /> to remove from the collection. </param> </Docs> </Member> <Member MemberName="RemoveAt"> @@ -224,9 +344,19 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.RemoveAt(System.Int32)" /> method to remove a group at a particular index from the collection. To remove a specified group from the collection, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Remove(System.Web.UI.Design.TemplateGroup)" /> method. To remove all the groups from the collection, use the <see cref="M:System.Web.UI.Design.TemplateGroupCollection.Clear" /> method.</para> + <block subset="none" type="note"> + <para>When you remove an item from the collection, the indexes change for subsequent items in the collection.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the <see cref="T:System.Web.UI.Design.TemplateGroup" /> object at the specified index within the collection.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index within the collection of the <see cref="T:System.Web.UI.Design.TemplateGroup" /> to remove.</param> </Docs> </Member> <Member MemberName="System.Collections.ICollection.CopyTo"> @@ -243,10 +373,18 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)" />.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Array" /> that is the destination of the copied groups. The <see cref="T:System.Array" /> must have zero-based indexing.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param> </Docs> </Member> <Member MemberName="System.Collections.ICollection.Count"> @@ -259,9 +397,15 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.ICollection.IsSynchronized"> @@ -274,9 +418,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.ICollection.SyncRoot"> @@ -289,9 +439,15 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.ICollection" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IEnumerable.GetEnumerator"> @@ -305,9 +461,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IEnumerable" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Add"> @@ -323,10 +485,17 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Add(System.Object)" />.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplateGroup" /> to add to the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.Clear"> @@ -340,8 +509,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Clear" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Contains"> @@ -357,10 +532,17 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Contains(System.Object)" />.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplateGroup" /> to locate within the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.IndexOf"> @@ -376,10 +558,17 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.IndexOf(System.Object)" />.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplateGroup" /> to locate within the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.Insert"> @@ -396,10 +585,18 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="o">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Insert(System.Int32,System.Object)" />.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index within the collection at which to insert <paramref name="o" />.</param> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to insert into the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.IsFixedSize"> @@ -412,9 +609,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.IList.IsFixedSize" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.IsReadOnly"> @@ -427,9 +630,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.Collections.IList.IsReadOnly" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IList.Item"> @@ -464,9 +673,16 @@ <Parameter Name="o" Type="System.Object" /> </Parameters> <Docs> - <param name="o">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.Remove(System.Object)" />.</para> + </summary> + <param name="o"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to remove from the collection.</param> </Docs> </Member> <Member MemberName="System.Collections.IList.RemoveAt"> @@ -482,10 +698,17 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Collections.IList.RemoveAt(System.Int32)" />.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index within the collection of the object to remove.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateModeChangedEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateModeChangedEventArgs.xml index f02c16702af..976deba7dcd 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateModeChangedEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateModeChangedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TemplateModeChangedEventArgs" FullName="System.Web.UI.Design.TemplateModeChangedEventArgs"> <TypeSignature Language="C#" Value="public class TemplateModeChangedEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,8 +10,18 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event is raised by a designer host, such as vsprvslong, for certain actions on a control on the design surface. For example, an event is raised when you enter or exit template editing mode for a control.</para> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default delegate to handle the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event. When you exit or enter template editing mode, the designer host initializes a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object for a <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" /> event type, and then sets the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property with a <see cref="T:System.Web.UI.Design.TemplateModeChangedEventArgs" /> object.</para> + <para>When the <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object indicates that the template mode has changed, the default delegate in the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class updates the value for the <see cref="P:System.Web.UI.Design.ControlDesigner.InTemplateMode" /> property.</para> + <para>Custom designers that are derived from the <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> class can override the <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> method to perform additional processing when the template editing mode changes for a control on the design surface.</para> + <para>For more information about events and delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for a <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event that is raised when the template mode changes for a control on the design surface.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +34,17 @@ <Parameter Name="newTemplateGroup" Type="System.Web.UI.Design.TemplateGroup" /> </Parameters> <Docs> - <param name="newTemplateGroup">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> delegate method uses the <see cref="M:System.Web.UI.Design.TemplateModeChangedEventArgs.#ctor(System.Web.UI.Design.TemplateGroup)" /> constructor to initialize a <see cref="T:System.Web.UI.Design.TemplateModeChangedEventArgs" /> object for use with a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object.</para> + <para>When you exit or enter template editing mode, the designer host initializes a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object for a <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" /> event type, and then sets the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property with a <see cref="T:System.Web.UI.Design.TemplateModeChangedEventArgs" /> object. The <paramref name="newTemplateGroup" /> parameter specifies a new template group when you enter template editing mode. The <paramref name="newTemplateGroup" /> parameter is typically null for exiting template editing mode.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateModeChangedEventArgs" /> class with the specified template group.</para> + </summary> + <param name="newTemplateGroup"> + <attribution license="cc4" from="Microsoft" modified="false" />A new template group that is used to initialize the <see cref="P:System.Web.UI.Design.TemplateModeChangedEventArgs.NewTemplateGroup" />.</param> </Docs> </Member> <Member MemberName="NewTemplateGroup"> @@ -38,10 +57,16 @@ <ReturnType>System.Web.UI.Design.TemplateGroup</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.TemplateModeChangedEventArgs.NewTemplateGroup" /> property specifies a new template group when you enter template editing mode. <see cref="P:System.Web.UI.Design.TemplateModeChangedEventArgs.NewTemplateGroup" /> is nullfor events that are raised when you exit template editing mode.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the template group that was created when you entered template editing mode.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplatedControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplatedControlDesigner.xml index 17ddeed8fcc..f033eb782d9 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplatedControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplatedControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TemplatedControlDesigner" FullName="System.Web.UI.Design.TemplatedControlDesigner"> <TypeSignature Language="C#" Value="public abstract class TemplatedControlDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends design-time behavior for template-based server controls.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +41,17 @@ <ReturnType>System.Web.UI.Design.ITemplateEditingFrame</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="P:System.Web.UI.Design.TemplatedControlDesigner.ActiveTemplateEditingFrame" /> property is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplatedControlDesigner.TemplateGroups" /> property to expose or enumerate templates within a designer for template-based controls.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the active template editing frame.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -55,9 +70,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether or not this designer will allow the viewing or editing of templates.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -74,10 +92,14 @@ <Parameter Name="verb" Type="System.Web.UI.Design.TemplateEditingVerb" /> </Parameters> <Docs> - <param name="verb">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, creates a template editing frame for the specified verb.</para> + </summary> + <param name="verb"> + <attribution license="cc4" from="Microsoft" modified="false" />The template editing verb to create a template editing frame for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -99,9 +121,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the designer allows data binding. </para> + </summary> </Docs> </Member> <Member MemberName="EnterTemplateMode"> @@ -114,9 +139,19 @@ <Parameter Name="newTemplateEditingFrame" Type="System.Web.UI.Design.ITemplateEditingFrame" /> </Parameters> <Docs> - <param name="newTemplateEditingFrame">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.EnterTemplateMode(System.Web.UI.Design.ITemplateEditingFrame)" /> method is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplatedControlDesigner.TemplateGroups" /> property to manipulate templates within a designer for template-based controls.</para> + </block> + <para>If already in template mode and editing a different template frame, this method calls <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.ExitTemplateMode(System.Boolean,System.Boolean,System.Boolean)" /> to save all its templates and close that frame.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Opens a particular template frame object for editing in the designer.</para> + </summary> + <param name="newTemplateEditingFrame"> + <attribution license="cc4" from="Microsoft" modified="false" />The template editing frame object to open in the designer. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -140,11 +175,22 @@ <Parameter Name="fSave" Type="System.Boolean" /> </Parameters> <Docs> - <param name="fSwitchingTemplates">To be added.</param> - <param name="fNested">To be added.</param> - <param name="fSave">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.ExitTemplateMode(System.Boolean,System.Boolean,System.Boolean)" /> method is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplatedControlDesigner.TemplateGroups" /> property to manipulate templates within a designer for template-based controls.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Closes the currently active template editing frame after saving any relevant changes.</para> + </summary> + <param name="fSwitchingTemplates"> + <attribution license="cc4" from="Microsoft" modified="false" />true when switching from one template editing frame to another; otherwise false. </param> + <param name="fNested"> + <attribution license="cc4" from="Microsoft" modified="false" />true if this designer is nested (one or more levels) within another control whose designer is also in template editing mode; otherwise false. </param> + <param name="fSave"> + <attribution license="cc4" from="Microsoft" modified="false" />true if templates should be saved on exit; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -164,9 +210,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.GetCachedTemplateEditingVerbs" /> method is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplatedControlDesigner.TemplateGroups" /> property to manipulate templates within a designer for template-based controls.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the cached template editing verbs.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -186,9 +240,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the markup to persist for the content that is in the associated server control runtime.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -204,10 +261,19 @@ <Parameter Name="templateName" Type="System.String" /> </Parameters> <Docs> - <param name="templateName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.GetTemplateContainerDataItemProperty(System.String)" /> method is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplateGroup.Templates" /> property of the <see cref="P:System.Web.UI.Design.TemplatedControlDesigner.TemplateGroups" /> collection elements to examine template metadata within a designer for template-based controls.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data item property of the template's container.</para> + </summary> + <param name="templateName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the template. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -229,10 +295,14 @@ <Parameter Name="templateName" Type="System.String" /> </Parameters> <Docs> - <param name="templateName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the data source of the template's container.</para> + </summary> + <param name="templateName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the template. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -281,9 +351,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the template editing verbs available to the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -305,10 +378,14 @@ <Parameter Name="text" Type="System.String" /> </Parameters> <Docs> - <param name="text">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a template from the specified text.</para> + </summary> + <param name="text"> + <attribution license="cc4" from="Microsoft" modified="false" />The text to retrieve a template from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -325,10 +402,19 @@ <Parameter Name="templateName" Type="System.String" /> </Parameters> <Docs> - <param name="templateName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.GetTemplatePropertyParentType(System.String)" /> method is obsolete. Use the <see cref="P:System.Web.UI.Design.TemplateGroup.Templates" /> property of the <see cref="P:System.Web.UI.Design.TemplatedControlDesigner.TemplateGroups" /> collection elements to examine template metadata within a designer for template-based controls.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type of the parent of the template property.</para> + </summary> + <param name="templateName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the template to return the type of the parent for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -350,10 +436,14 @@ <Parameter Name="template" Type="System.Web.UI.ITemplate" /> </Parameters> <Docs> - <param name="template">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a string of text that represents the specified template.</para> + </summary> + <param name="template"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.ITemplate" /> to convert to text. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -367,9 +457,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ControlDesigner.ID" /> property is never hidden.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the properties of the control will be hidden when the control is placed into template editing mode.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -389,9 +485,13 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer and loads the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The control element being designed.</param> </Docs> </Member> <Member MemberName="InTemplateMode"> @@ -401,9 +501,18 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="P:System.Web.UI.Design.TemplatedControlDesigner.InTemplateMode" /> property is obsolete. Use the <see cref="P:System.Web.UI.Design.ControlDesigner.InTemplateMode" /> property for equivalent control designer functionality.</para> + </block> + <para>A document is in template mode when a template is currently being viewed or edited in the forms designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the designer document is in template mode.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -423,8 +532,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>The <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnBehaviorAttached" /> method is obsolete. Use the <see cref="M:System.Web.UI.Design.IControlDesignerTag.SetAttribute(System.String,System.String)" /> and <see cref="M:System.Web.UI.Design.IControlDesignerTag.GetAttribute(System.String)" /> methods on the <see cref="P:System.Web.UI.Design.ControlDesigner.Tag" /> property to map properties to styles.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an opportunity to perform additional processing when a behavior is attached to the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -447,10 +564,18 @@ <Parameter Name="ce" Type="System.ComponentModel.Design.ComponentChangedEventArgs" /> </Parameters> <Docs> - <param name="sender">To be added.</param> - <param name="ce">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called after a property has been changed. It allows the implementer to perform any post-processing that may be needed after a property change.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Delegate to handle the component changed event.</para> + </summary> + <param name="sender"> + <attribution license="cc4" from="Microsoft" modified="false" />The object sending the event. </param> + <param name="ce"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.ComponentChangedEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -465,8 +590,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an opportunity to perform additional processing when the parent of this designer is changed.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -481,8 +609,18 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event is raised by the designer host for certain actions on a control in the design surface. For example, an event is raised when the user enters or exits template editing mode for a control.</para> + <para>The <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> class supplies a default delegate to handle the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event. Classes deriving from the <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> override the <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> method to process events that are raised when the template mode changes for the associated control.</para> + <para>The <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> + <para>The default delegate performs the updates that are required for a template mode change event in the base <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> class, and then calls the <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> method. The base <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> method in the <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> class returns without performing any additional processing for the event. If a class derives from the <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> and overrides the base <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> method, the default delegate calls the override method in the derived class.</para> + <para>Use the <see cref="P:System.Web.UI.Design.ControlDesigner.InTemplateMode" /> property to determine whether the control designer is in template editing mode currently.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an opportunity to perform additional processing when the template mode is changed.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -499,9 +637,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called immediately before its corresponding Post method. If you are overriding this method, you should call the base implementation before you perform your own filtering.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to filter the set of member attributes the component it is designing through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The member attributes for component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -515,8 +660,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Saves the active template editing frame.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -535,11 +683,17 @@ <Parameter Name="templateContent" Type="System.String" /> </Parameters> <Docs> - <param name="editingFrame">To be added.</param> - <param name="templateName">To be added.</param> - <param name="templateContent">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, sets the specified template's content to the specified content.</para> + </summary> + <param name="editingFrame"> + <attribution license="cc4" from="Microsoft" modified="false" />The template editing frame to provide content for. </param> + <param name="templateName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the template. </param> + <param name="templateContent"> + <attribution license="cc4" from="Microsoft" modified="false" />The content to set for the template. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -561,9 +715,12 @@ <ReturnType>System.Web.UI.Design.TemplateGroupCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of template groups, each containing a template definition.</para> + </summary> </Docs> </Member> <Member MemberName="UpdateDesignTimeHtml"> @@ -574,8 +731,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You should call this method to refresh the design-time display if the template frames have been changed without calling methods that update the design-time HTML automatically.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Updates the design-time HTML.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -583,4 +746,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplatedEditableDesignerRegion.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplatedEditableDesignerRegion.xml index 759888d8e5d..499166fd5f8 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplatedEditableDesignerRegion.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplatedEditableDesignerRegion.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TemplatedEditableDesignerRegion" FullName="System.Web.UI.Design.TemplatedEditableDesignerRegion"> <TypeSignature Language="C#" Value="public class TemplatedEditableDesignerRegion : System.Web.UI.Design.EditableDesignerRegion" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines an editable region of content within the design-time markup for the associated control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +27,13 @@ <Parameter Name="templateDefinition" Type="System.Web.UI.Design.TemplateDefinition" /> </Parameters> <Docs> - <param name="templateDefinition">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> class using the provided template definition.</para> + </summary> + <param name="templateDefinition"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.TemplateDefinition" /> instance for the template to edit.</param> </Docs> </Member> <Member MemberName="IsSingleInstanceTemplate"> @@ -38,9 +46,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets whether the template occurs only once per instance of the containing control, such as a header template, or can appear many times according to available data, such as an item template.</para> + </summary> </Docs> </Member> <Member MemberName="SupportsDataBinding"> @@ -53,9 +64,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value that indicates whether the template can be bound to a data source.</para> + </summary> </Docs> </Member> <Member MemberName="TemplateDefinition"> @@ -68,10 +82,13 @@ <ReturnType>System.Web.UI.Design.TemplateDefinition</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a <see cref="T:System.Web.UI.Design.TemplateDefinition" /> object describing the template that is referenced by the region.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TextControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TextControlDesigner.xml index ee49b636ff3..59a3c0eca93 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TextControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TextControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TextControlDesigner" FullName="System.Web.UI.Design.TextControlDesigner"> <TypeSignature Language="C#" Value="public class TextControlDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This class can be used as the base class for designers for run-time controls that have a string Text property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends design-time behavior for Web server controls that have a Text property that is persisted as inner text.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TextControlDesigner" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -35,9 +45,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This class overrides this method to ensure that a non-empty Text property value is available when the control is rendered for display on the design surface. This makes sure that the class has a meaningful representation. This method sets any empty Text property of the control to the <see cref="P:System.Web.UI.Control.ID" /> property of the control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the markup that is used to represent the associated control at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -52,9 +68,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the markup to persist for the inner tags of the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -70,13 +89,17 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer with the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />An object that implements <see cref="T:System.ComponentModel.IComponent" /> for this designer to design. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TextDataBindingHandler.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TextDataBindingHandler.xml index ef9179a76b9..fe9fa567845 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TextDataBindingHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TextDataBindingHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TextDataBindingHandler" FullName="System.Web.UI.Design.TextDataBindingHandler"> <TypeSignature Language="C#" Value="public class TextDataBindingHandler : System.Web.UI.Design.DataBindingHandler" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.TextDataBindingHandler" /> object is a data-binding handler that can provide data to a data-bound text property at design time. Data-binding handlers are used when there is no designer for the control present that would otherwise provide the data for the data bound property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a data-binding handler for a data-bound control at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TextDataBindingHandler" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,10 +48,19 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="designerHost">To be added.</param> - <param name="control">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.TextDataBindingHandler.DataBindControl(System.ComponentModel.Design.IDesignerHost,System.Web.UI.Control)" /> method of <see cref="T:System.Web.UI.Design.TextDataBindingHandler" /> sets the Text property of the control, if it exists, to a sample data string.</para> + <para>This method should be implemented in a derived class to provide functionality to a custom data-binding handler. The logic for the data-binding should be implemented within this method, and can be specific to the type or types that the handler is binding a property or properties on.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Data-binds the specified control.</para> + </summary> + <param name="designerHost"> + <attribution license="cc4" from="Microsoft" modified="false" />An object implementing <see cref="T:System.ComponentModel.Design.IDesignerHost" /> for the document that contains the control. </param> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> to data-bind. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -49,4 +68,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TransactedChangeCallback.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TransactedChangeCallback.xml index e2c13826828..78b7c4043e1 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TransactedChangeCallback.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TransactedChangeCallback.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TransactedChangeCallback" FullName="System.Web.UI.Design.TransactedChangeCallback"> <TypeSignature Language="C#" Value="public delegate bool TransactedChangeCallback(object context);" /> <AssemblyInfo> @@ -15,8 +16,11 @@ </ReturnValue> <Docs> <param name="context">To be added.</param> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A delegate that refers to a method in a custom <see cref="T:System.ComponentModel.Design.DesignerActionList" /> object that is to be called by the <see cref="Overload:System.Web.UI.Design.ControlDesigner.InvokeTransactedChange" /> method for implementing property changes in the designer's associated control.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TypeSchema.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TypeSchema.xml index e3b9ee3d159..0a4ecc1e0d8 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TypeSchema.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TypeSchema.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TypeSchema" FullName="System.Web.UI.Design.TypeSchema"> <TypeSignature Language="C#" Value="public sealed class TypeSchema : System.Web.UI.Design.IDataSourceSchema" /> <AssemblyInfo> @@ -13,8 +14,15 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.TypeSchema" /> class provides information about a particular class, given an instance of that class. For example, given a <see cref="T:System.Data.DataSet" /> object, a <see cref="T:System.Web.UI.WebControls.GridView" /> object, or an instance of a custom class that you create, the methods and properties provide information about the class from which the object derives. It does not provide information about the specific instance, but about the class.</para> + <para>The <see cref="T:System.Web.UI.Design.TypeSchema" /> class is used by custom control designers to assist in preparing sample data for previewing custom controls.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the structure, or schema, of an object type.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,9 +35,13 @@ <Parameter Name="type" Type="System.Type" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new instance of the <see cref="T:System.Web.UI.Design.TypeSchema" /> class using the provided <see cref="T:System.Type" /> object.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Type" /> that describes an object.</param> </Docs> </Member> <Member MemberName="GetViews"> @@ -43,10 +55,61 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Although the <see cref="M:System.Web.UI.Design.TypeSchema.GetViews" /> method always returns an array of <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" /> objects that implement the <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" /> interface, the exact return value is dependent on the object that is provided when creating the instance of the <see cref="T:System.Web.UI.Design.TypeSchema" /> class.</para> + <para>The following table provides examples of return values.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Underlying Type</para> + </term> + <description> + <para>Return Value</para> + </description> + </item> + </listheader> + <item> + <term> + <para>A <see cref="T:System.Data.DataSet" /> </para> + </term> + <description> + <para>An array of type <see cref="T:System.Web.UI.Design.DataSetViewSchema" />, one for each <see cref="T:System.Data.DataTable" />.</para> + </description> + </item> + <item> + <term> + <para>A <see cref="T:System.Data.DataTable" /></para> + </term> + <description> + <para>A one-item array containing a <see cref="T:System.Web.UI.Design.DataSetViewSchema" />.</para> + </description> + </item> + <item> + <term> + <para>An <see cref="T:System.Collections.IEnumerable" /> type</para> + </term> + <description> + <para>A one-item array containing an <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" />.</para> + </description> + </item> + <item> + <term> + <para>Any other type</para> + </term> + <description> + <para>A one-item array containing an <see cref="T:System.Web.UI.Design.IDataSourceViewSchema" />.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array of schema descriptors for views into a data source.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlBuilder.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlBuilder.xml index 4d8181a982f..72a13ef7fe4 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlBuilder.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlBuilder.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="UrlBuilder" FullName="System.Web.UI.Design.UrlBuilder"> <TypeSignature Language="C#" Value="public sealed class UrlBuilder" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method starts a user interface for selecting a URL.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Starts a URL editor that allows a user to select or create a URL. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName="BuildUrl"> @@ -28,14 +35,22 @@ <Parameter Name="filter" Type="System.String" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="owner">To be added.</param> - <param name="initialUrl">To be added.</param> - <param name="caption">To be added.</param> - <param name="filter">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a UI to create or pick a URL.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> whose site is to be used to access design-time services. </param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Control" /> used as the parent for the picker window. </param> + <param name="initialUrl"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial URL to be shown in the picker window. </param> + <param name="caption"> + <attribution license="cc4" from="Microsoft" modified="false" />The caption of the picker window. </param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />The filter string to use to optionally filter the files displayed in the picker window. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -57,15 +72,24 @@ <Parameter Name="options" Type="System.Web.UI.Design.UrlBuilderOptions" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="owner">To be added.</param> - <param name="initialUrl">To be added.</param> - <param name="caption">To be added.</param> - <param name="filter">To be added.</param> - <param name="options">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a UI to create or pick a URL, using the specified <see cref="T:System.Web.UI.Design.UrlBuilderOptions" /> object.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> whose site is to be used to access design-time services. </param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Control" /> used as the parent for the picker window. </param> + <param name="initialUrl"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial URL to be shown in the picker window. </param> + <param name="caption"> + <attribution license="cc4" from="Microsoft" modified="false" />The caption of the picker window. </param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />The filter string to use to optionally filter the files displayed in the picker window. </param> + <param name="options"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.UrlBuilderOptions" /> indicating the options for URL selection. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -90,16 +114,28 @@ <Parameter Name="options" Type="System.Web.UI.Design.UrlBuilderOptions" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <param name="owner">To be added.</param> - <param name="initialUrl">To be added.</param> - <param name="caption">To be added.</param> - <param name="filter">To be added.</param> - <param name="options">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.IServiceProvider" /> interface is used to obtain the <see cref="T:System.ComponentModel.Design.IDesignerHost" /> implementation for the designer host. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a UI to create or pick a URL, using the specified <see cref="T:System.Web.UI.Design.UrlBuilderOptions" /> object.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IServiceProvider" /> to be used to access design-time services.</param> + <param name="owner"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Control" /> used as the parent for the picker window.</param> + <param name="initialUrl"> + <attribution license="cc4" from="Microsoft" modified="false" />The initial URL to be shown in the picker window.</param> + <param name="caption"> + <attribution license="cc4" from="Microsoft" modified="false" />The caption of the picker window.</param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />The filter string to use to optionally filter the files displayed in the picker window.</param> + <param name="options"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.UrlBuilderOptions" /> indicating the options for URL selection.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlBuilderOptions.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlBuilderOptions.xml index 6863626d6f3..78cb8a09b98 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlBuilderOptions.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlBuilderOptions.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="UrlBuilderOptions" FullName="System.Web.UI.Design.UrlBuilderOptions"> <TypeSignature Language="C#" Value="public enum UrlBuilderOptions" /> <AssemblyInfo> @@ -14,8 +15,11 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines identifiers for settings of a <see cref="T:System.Web.UI.Design.UrlBuilder" />.</para> + </summary> </Docs> <Members> <Member MemberName="NoAbsolute"> @@ -25,7 +29,10 @@ <ReturnType>System.Web.UI.Design.UrlBuilderOptions</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Build a URL that references a path relative to the current path, rather than one that references a fully qualified, absolute path.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,7 +46,10 @@ <ReturnType>System.Web.UI.Design.UrlBuilderOptions</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use no additional options for the <see cref="T:System.Web.UI.Design.UrlBuilder" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -47,4 +57,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlEditor.xml index 338908d4285..aa456779968 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UrlEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="UrlEditor" FullName="System.Web.UI.Design.UrlEditor"> <TypeSignature Language="C#" Value="public class UrlEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.UrlEditor" /> is a <see cref="T:System.Drawing.Design.UITypeEditor" /> that provides a dialog box for selecting a URL.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for selecting a URL.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.UrlEditor" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +45,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption to display on the selection dialog box.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -55,12 +69,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the specified object using the editor style provided by the <see cref="M:System.Web.UI.Design.UrlEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which editing services may be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the value being edited. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -74,9 +94,20 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.UrlEditor.Filter" /> property specifies a filter string for all files (*.*).</para> + <para>A filter string contains one or more filter options. Each filter option contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. </para> + <para>The following is an example of a filter string that contains two filter options: </para> + <para>"Text Files (*.txt)|*.txt|All Files (*.*)|*.*".</para> + <para>You can specify several filter patterns in a filter option by separating the filter patterns with semicolons. The following is an example of a filter string in which the first filter option specifies three filter patterns: </para> + <para>"Text Files(*.txt;*.text;*.lst)|*.txt;*.text;*.lst|All Files (*.*)|*.*".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the file name filter string for the editor. This is used to determine the items that appear in the file list of the dialog box.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -93,10 +124,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editing style of the <see cref="M:System.Web.UI.Design.UrlEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -110,9 +145,12 @@ <ReturnType>System.Web.UI.Design.UrlBuilderOptions</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the options for the URL builder to use.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -120,4 +158,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UserControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UserControlDesigner.xml index 599bf521fa2..6ceebca4bd7 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UserControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UserControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="UserControlDesigner" FullName="System.Web.UI.Design.UserControlDesigner"> <TypeSignature Language="C#" Value="public class UserControlDesigner : System.Web.UI.Design.ControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>There is no developer advantage to creating your own designer derived from <see cref="T:System.Web.UI.Design.UserControlDesigner" />. To enhance the design-time experience for a custom control, derive your control from <see cref="T:System.Web.UI.WebControls.CompositeControl" /> and your designer from <see cref="T:System.Web.UI.Design.WebControls.CompositeControlDesigner" />. In that case, you would not use an .ascx file for your ASP.NET markup.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides designer functionality for user controls.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.UserControlDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,9 +47,15 @@ <ReturnType>System.ComponentModel.Design.DesignerActionListCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This implementation creates two <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> objects in the collection: <ui>Edit User Control</ui> and <ui>Refresh</ui>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the action list collection for the user control designer.</para> + </summary> </Docs> </Member> <Member MemberName="AllowResize"> @@ -49,9 +65,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the user control can be resized.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -66,9 +85,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the HTML markup that is used to represent the user control at design time.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -83,9 +105,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member overrides <see cref="M:System.Web.UI.Design.ControlDesigner.GetPersistInnerHtml" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -98,9 +123,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member overrides <see cref="P:System.Web.UI.Design.HtmlControlDesigner.ShouldCodeSerialize" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -113,4 +141,4 @@ </Attributes> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UserControlFileEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UserControlFileEditor.xml index e7fc6547cc2..7398a7650ef 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UserControlFileEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/UserControlFileEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="UserControlFileEditor" FullName="System.Web.UI.Design.UserControlFileEditor"> <TypeSignature Language="C#" Value="public class UserControlFileEditor : System.Web.UI.Design.UrlEditor" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a dialog box for selecting files to edit at design time.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.UserControlFileEditor" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="Caption"> @@ -35,9 +42,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption for the dialog box.</para> + </summary> </Docs> </Member> <Member MemberName="Filter"> @@ -50,10 +60,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the file name filter string used to determine the items that appear in the file list of the dialog box.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEvent.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEvent.xml index decd7ee1055..fac57170202 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEvent.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEvent.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ViewEvent" FullName="System.Web.UI.Design.ViewEvent"> <TypeSignature Language="C#" Value="public sealed class ViewEvent" /> <AssemblyInfo> @@ -9,8 +10,39 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.Web.UI.Design.ViewEvent" /> object is provided to the designer component by the design host, for example vsprvslong, when raising an event caused by certain user actions on the design-time view of a control. The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event is handled by a <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate method, which takes a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object as a parameter. The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property of the <see cref="T:System.Web.UI.Design.ViewEventArgs" /> class is a <see cref="T:System.Web.UI.Design.ViewEvent" /> object. The <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate method compares the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property to the static <see cref="T:System.Web.UI.Design.ViewEvent" /> fields to determine which type of action raised the event. For example, an event is raised under the following circumstances:</para> + <list type="bullet"> + <item> + <para>You click a region on the design surface.</para> + </item> + <item> + <para>The designer draws a control on the design surface.</para> + </item> + <item> + <para>You enter or exit template editing mode for a control.</para> + </item> + </list> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default delegate to handle the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event. Custom control designers override the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" />, <see cref="M:System.Web.UI.Design.ControlDesigner.OnPaint(System.Windows.Forms.PaintEventArgs)" />, and <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> methods to process those events for the control on the design surface.</para> + <para>The designer host initializes a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object for the type of action on the design surface, and then passes the object to the <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate. The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property of the <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object indicates which type of action: </para> + <list type="bullet"> + <item> + <para>A <see cref="F:System.Web.UI.Design.ViewEvent.Click" /> event.</para> + </item> + <item> + <para>A <see cref="F:System.Web.UI.Design.ViewEvent.Paint" /> event.</para> + </item> + <item> + <para>A <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" /> event. </para> + </item> + </list> + <para>The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property supplies the event arguments that are specific to the type of action. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the kind of event that has occurred on a view of a control at design time. This class cannot be inherited. </para> + </summary> </Docs> <Members> <Member MemberName="Click"> @@ -23,8 +55,15 @@ <ReturnType>System.Web.UI.Design.ViewEvent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate method compares the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property to the static <see cref="T:System.Web.UI.Design.ViewEvent" /> fields to determine which type of action raised the event. A <see cref="T:System.Web.UI.Design.ViewEvent" /> object is equal to <see cref="F:System.Web.UI.Design.ViewEvent.Click" /> to indicate that you clicked a region on the design surface.</para> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate. If the event type is <see cref="F:System.Web.UI.Design.ViewEvent.Click" />, the delegate calls the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method. Classes deriving from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class override the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method to handle click events on a region at design time. The event arguments indicate which designer region was clicked, if any.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates that a view event was raised for a click on a designer region.</para> + </summary> </Docs> </Member> <Member MemberName="Paint"> @@ -37,8 +76,15 @@ <ReturnType>System.Web.UI.Design.ViewEvent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate method compares the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property to the static <see cref="T:System.Web.UI.Design.ViewEvent" /> fields to determine which type of action raised the event. A <see cref="T:System.Web.UI.Design.ViewEvent" /> object is equal to <see cref="F:System.Web.UI.Design.ViewEvent.Paint" /> to indicate a paint event on the control on the design surface.</para> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate. If the event type is <see cref="F:System.Web.UI.Design.ViewEvent.Paint" />, the delegate calls the <see cref="M:System.Web.UI.Design.ControlDesigner.OnPaint(System.Windows.Forms.PaintEventArgs)" /> method. Classes deriving from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class override the <see cref="M:System.Web.UI.Design.ControlDesigner.OnPaint(System.Windows.Forms.PaintEventArgs)" /> method to handle click events on a region at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates that a view event was raised for drawing a control on the design surface.</para> + </summary> </Docs> </Member> <Member MemberName="TemplateModeChanged"> @@ -51,9 +97,17 @@ <ReturnType>System.Web.UI.Design.ViewEvent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate method compares the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property to the static <see cref="T:System.Web.UI.Design.ViewEvent" /> fields to determine which type of action raised the event. A <see cref="T:System.Web.UI.Design.ViewEvent" /> object is equal to <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" /> to indicate that the template editing mode changed for a control on the design surface.</para> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate. If the event type is <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" />, the delegate sets the value for the <see cref="P:System.Web.UI.Design.ControlDesigner.InTemplateMode" /> property.</para> + <para>Custom designers that are derived from the <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> class can override the <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> method to perform additional processing when the template editing mode changes for a control on the design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates that a view event was raised for changing the template mode of a control designer.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEventArgs.xml index 5d5146932be..81af246adeb 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ViewEventArgs" FullName="System.Web.UI.Design.ViewEventArgs"> <TypeSignature Language="C#" Value="public class ViewEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,8 +10,41 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event is raised by the designer host for certain actions on a control on the design surface. The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> is handled by a <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate method, which takes a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object as a parameter. </para> + <para>The <see cref="T:System.Web.UI.Design.ControlDesigner" /> class supplies a default delegate to handle the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" />. Custom control designers override the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" />, <see cref="M:System.Web.UI.Design.ControlDesigner.OnPaint(System.Windows.Forms.PaintEventArgs)" />, and <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> methods to process those events for the control on the design surface.</para> + <para>The designer host initializes a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object for the type of action on the design surface, and then passes the object to the <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate. The <see cref="P:System.Web.UI.Design.ViewEventArgs.Region" /> property represents the control designer region that the event applies to. The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property of the <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object indicates which type of action: </para> + <list type="bullet"> + <item> + <para>A <see cref="F:System.Web.UI.Design.ViewEvent.Click" /> event.</para> + </item> + <item> + <para>A <see cref="F:System.Web.UI.Design.ViewEvent.Paint" /> event.</para> + </item> + <item> + <para>A <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" /> event. </para> + </item> + </list> + <para>The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property supplies the event arguments that are specific to the type of action. </para> + <para>For example, the designer host initializes <see cref="T:System.Web.UI.Design.ViewEventArgs" /> objects as follows: </para> + <list type="bullet"> + <item> + <para>A <see cref="T:System.Web.UI.Design.DesignerRegionMouseEventArgs" /> object when you click a region.</para> + </item> + <item> + <para>A <see cref="T:System.Windows.Forms.PaintEventArgs" /> object when a control is drawn on the design surface.</para> + </item> + <item> + <para>A <see cref="T:System.Web.UI.Design.TemplateModeChangedEventArgs" /> object when the template editing mode changes for the control on the design surface.</para> + </item> + </list> + <para>For more information about events and delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -25,11 +59,21 @@ <Parameter Name="eventArgs" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="eventType">To be added.</param> - <param name="region">To be added.</param> - <param name="eventArgs">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.ViewEventArgs.#ctor(System.Web.UI.Design.ViewEvent,System.Web.UI.Design.DesignerRegion,System.EventArgs)" /> constructor is used by the designer host to initialize a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object for the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event. The designer host passes the initialized <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object to the <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate.</para> + <para>Typically, <paramref name="region" /> is set for <see cref="F:System.Web.UI.Design.ViewEvent.Click" /> events, and null (Nothing in Visual Basic) for <see cref="F:System.Web.UI.Design.ViewEvent.Paint" /> and <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" /> events.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ViewEventArgs" /> class for the type of view event on the design surface. </para> + </summary> + <param name="eventType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of action that raised the event; used to initialize the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" />.</param> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The designer region that the action applies to; used to initialize the <see cref="P:System.Web.UI.Design.ViewEventArgs.Region" />.</param> + <param name="eventArgs"> + <attribution license="cc4" from="Microsoft" modified="false" />The event arguments associated with <paramref name="eventType" />; used to initialize the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" />.</param> </Docs> </Member> <Member MemberName="EventArgs"> @@ -42,9 +86,18 @@ <ReturnType>System.EventArgs</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property supplies the event arguments that are specific to the type of action that is specified in the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property. </para> + <para>For example, when you click a region, the designer host initializes the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> as a <see cref="F:System.Web.UI.Design.ViewEvent.Click" /> event, and then initializes the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property as a <see cref="T:System.Web.UI.Design.DesignerRegionMouseEventArgs" /> object.</para> + <para>Similarly, the designer host initializes the <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property with a <see cref="T:System.Windows.Forms.PaintEventArgs" /> object for a <see cref="F:System.Web.UI.Design.ViewEvent.Paint" /> event, or a <see cref="T:System.Web.UI.Design.TemplateModeChangedEventArgs" /> object for a <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" /> event.</para> + <para>The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property is initialized by the <see cref="M:System.Web.UI.Design.ViewEventArgs.#ctor(System.Web.UI.Design.ViewEvent,System.Web.UI.Design.DesignerRegion,System.EventArgs)" /> constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the event arguments that are associated with the action that raised the event.</para> + </summary> </Docs> </Member> <Member MemberName="EventType"> @@ -57,9 +110,28 @@ <ReturnType>System.Web.UI.Design.ViewEvent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property of the <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object indicates which type of action raised the event: </para> + <list type="bullet"> + <item> + <para>A <see cref="F:System.Web.UI.Design.ViewEvent.Click" /> event.</para> + </item> + <item> + <para>A <see cref="F:System.Web.UI.Design.ViewEvent.Paint" /> event.</para> + </item> + <item> + <para>A <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" /> event.</para> + </item> + </list> + <para>The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventArgs" /> property supplies the event arguments that are specific to the type of action.</para> + <para>The <see cref="P:System.Web.UI.Design.ViewEventArgs.EventType" /> property is initialized by the <see cref="M:System.Web.UI.Design.ViewEventArgs.#ctor(System.Web.UI.Design.ViewEvent,System.Web.UI.Design.DesignerRegion,System.EventArgs)" /> constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type of action that raised the event.</para> + </summary> </Docs> </Member> <Member MemberName="Region"> @@ -72,10 +144,17 @@ <ReturnType>System.Web.UI.Design.DesignerRegion</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.ViewEventArgs.Region" /> property represents the control designer region that the event applies to. Typically, the <see cref="P:System.Web.UI.Design.ViewEventArgs.Region" /> property is set for <see cref="F:System.Web.UI.Design.ViewEvent.Click" /> events, and null (Nothing in Visual Basic) for <see cref="F:System.Web.UI.Design.ViewEvent.Paint" /> and <see cref="F:System.Web.UI.Design.ViewEvent.TemplateModeChanged" /> events.</para> + <para>The <see cref="P:System.Web.UI.Design.ViewEventArgs.Region" /> property is initialized by the <see cref="M:System.Web.UI.Design.ViewEventArgs.#ctor(System.Web.UI.Design.ViewEvent,System.Web.UI.Design.DesignerRegion,System.EventArgs)" /> constructor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the designer region that the event applies to.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEventHandler.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEventHandler.xml index b73543ab36e..97f7f78e2e3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEventHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ViewEventHandler" FullName="System.Web.UI.Design.ViewEventHandler"> <TypeSignature Language="C#" Value="public delegate void ViewEventHandler(object sender, ViewEventArgs e);" /> <AssemblyInfo> @@ -17,7 +18,15 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When you create a <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>.</para> + <para>The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event is raised by the designer host for certain actions on a control on the design surface. The <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event is handled by a <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate method, which takes a <see cref="T:System.Web.UI.Design.ViewEventArgs" /> object as a parameter.</para> + <para>Typically, control designer classes do not directly implement or assign a <see cref="T:System.Web.UI.Design.ViewEventHandler" /> delegate. The <see cref="T:System.Web.UI.Design.ControlDesigner" /> base class supplies a default delegate for the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event. Custom control designers override the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" />, <see cref="M:System.Web.UI.Design.ControlDesigner.OnPaint(System.Windows.Forms.PaintEventArgs)" />, and <see cref="M:System.Web.UI.Design.TemplatedControlDesigner.OnTemplateModeChanged" /> methods to process those events for the control on the design surface. The <see cref="M:System.Web.UI.Design.ControlDesigner.Initialize(System.ComponentModel.IComponent)" /> method sets the default event delegate for the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> delegate.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:System.Web.UI.Design.IControlDesignerView.ViewEvent" /> event that is raised by visual design tools, such as vsprvslong, implementing the <see cref="T:System.Web.UI.Design.IControlDesignerView" /> interface. This class cannot be inherited.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewFlags.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewFlags.xml index 9512e57544d..7d3c88a7ad3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewFlags.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewFlags.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ViewFlags" FullName="System.Web.UI.Design.ViewFlags"> <TypeSignature Language="C#" Value="public enum ViewFlags" /> <AssemblyInfo> @@ -13,8 +14,11 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates which features are enabled with the <see cref="M:System.Web.UI.Design.ControlDesigner.SetViewFlags(System.Web.UI.Design.ViewFlags,System.Boolean)" /> method of a designer.</para> + </summary> </Docs> <Members> <Member MemberName="CustomPaint"> @@ -27,7 +31,10 @@ <ReturnType>System.Web.UI.Design.ViewFlags</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enables painting events for displaying a custom control at design time.</para> + </summary> </Docs> </Member> <Member MemberName="DesignTimeHtmlRequiresLoadComplete"> @@ -40,7 +47,10 @@ <ReturnType>System.Web.UI.Design.ViewFlags</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Postpones all events until after the control is completely loaded.</para> + </summary> </Docs> </Member> <Member MemberName="TemplateEditing"> @@ -53,8 +63,11 @@ <ReturnType>System.Web.UI.Design.ViewFlags</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enables template editing at design time.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewRendering.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewRendering.xml index dd37b5d716e..113db567a36 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewRendering.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ViewRendering.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ViewRendering" FullName="System.Web.UI.Design.ViewRendering"> <TypeSignature Language="C#" Value="public class ViewRendering" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Contains the design-time markup for content and regions.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +28,15 @@ <Parameter Name="regions" Type="System.Web.UI.Design.DesignerRegionCollection" /> </Parameters> <Docs> - <param name="content">To be added.</param> - <param name="regions">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ViewRendering" /> class by using the specified content and regions.</para> + </summary> + <param name="content"> + <attribution license="cc4" from="Microsoft" modified="false" />HTML markup.</param> + <param name="regions"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection that contains the regions.</param> </Docs> </Member> <Member MemberName="Content"> @@ -40,9 +49,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design-time HTML markup.</para> + </summary> </Docs> </Member> <Member MemberName="Regions"> @@ -55,10 +67,13 @@ <ReturnType>System.Web.UI.Design.DesignerRegionCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of <see cref="T:System.Web.UI.Design.DesignerRegion" /> objects at design time.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebControlToolboxItem.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebControlToolboxItem.xml index 13bd1b2e805..ad463507623 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebControlToolboxItem.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebControlToolboxItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="WebControlToolboxItem" FullName="System.Web.UI.Design.WebControlToolboxItem"> <TypeSignature Language="C#" Value="public class WebControlToolboxItem : System.Drawing.Design.ToolboxItem" /> <AssemblyInfo> @@ -10,8 +11,29 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.WebControlToolboxItem" /> provides a base class for toolbox items that create Web server controls. This class extends <see cref="T:System.Drawing.Design.ToolboxItem" /> and provides the following additional methods: </para> + <list type="bullet"> + <item> + <para> + <see cref="M:System.Web.UI.Design.WebControlToolboxItem.GetToolAttributeValue(System.ComponentModel.Design.IDesignerHost,System.Type)" /> gets the value of an attribute of the toolbox item.</para> + </item> + <item> + <para> + <see cref="M:System.Web.UI.Design.WebControlToolboxItem.GetToolHtml(System.ComponentModel.Design.IDesignerHost)" /> gets the HTML that represents the initial state of the control.</para> + </item> + <item> + <para> + <see cref="M:System.Web.UI.Design.WebControlToolboxItem.GetToolType(System.ComponentModel.Design.IDesignerHost)" /> gets the type of the associated runtime component.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base class for a Web server control <see cref="T:System.Drawing.Design.ToolboxItem" />.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +41,14 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Drawing.Design.ToolboxItem.DisplayName" /> is set to a short version of the type name.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControlToolboxItem" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +62,16 @@ <Parameter Name="type" Type="System.Type" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Drawing.Design.ToolboxItem.DisplayName" /> is set to a short version of the type name.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new instance of the <see cref="T:System.Web.UI.Design.WebControlToolboxItem" /> class using the provided type.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the tool for this toolbox item. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -54,10 +89,15 @@ <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new instance of the <see cref="T:System.Web.UI.Design.WebControlToolboxItem" /> class using the provided <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object and <see cref="T:System.Runtime.Serialization.StreamingContext" />.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />A SerializationInfo object containing information needed to instantiate the Web control through deserialization.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />A StreamingContext object.</param> </Docs> </Member> <Member MemberName="CreateComponentsCore"> @@ -70,10 +110,18 @@ <Parameter Name="host" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="host">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="M:System.Web.UI.Design.WebControlToolboxItem.CreateComponentsCore(System.ComponentModel.Design.IDesignerHost)" /> always throws an exception, indicating that the method is inherited from <see cref="T:System.Drawing.Design.ToolboxItem" /> and only intended for use with Windows Forms.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates objects from each type contained in this <see cref="T:System.Drawing.Design.ToolboxItem" />, and adds them to the specified designer.</para> + </summary> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.IDesignerHost" /> for the current design document. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -91,10 +139,15 @@ <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Loads the state of the toolbox item from the specified serialization information object.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that describes the <see cref="T:System.Web.UI.Design.WebControlToolboxItem" />.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that indicates the serialization stream characteristics. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -112,11 +165,19 @@ <Parameter Name="attributeType" Type="System.Type" /> </Parameters> <Docs> - <param name="host">To be added.</param> - <param name="attributeType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation will throw an <see cref="T:System.ArgumentException" /> if the <paramref name="attributeType" /> parameter is anything other than a <see cref="T:System.Web.UI.PersistChildrenAttribute" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the value of the specified type of attribute of the toolbox item.</para> + </summary> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.IDesignerHost" /> for the current design document. </param> + <param name="attributeType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of attribute to retrieve the value of. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -133,10 +194,14 @@ <Parameter Name="host" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="host">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the HTML for the Web control that the tool creates.</para> + </summary> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.IDesignerHost" /> for the current design document. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -153,10 +218,14 @@ <Parameter Name="host" Type="System.ComponentModel.Design.IDesignerHost" /> </Parameters> <Docs> - <param name="host">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type of this toolbox item.</para> + </summary> + <param name="host"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.IDesignerHost" /> for the current design document. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -173,9 +242,13 @@ <Parameter Name="type" Type="System.Type" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes this toolbox item.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the Web server control toolbox item. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -193,10 +266,15 @@ <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Saves the state of the toolbox item to the specified serialization information object.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> used to save the state of the <see cref="T:System.Web.UI.Design.WebControlToolboxItem" />.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that indicates the serialization stream characteristics.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -204,4 +282,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsDesignerActionService.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsDesignerActionService.xml index f4dbf5b6ec7..c22f6f3949a 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsDesignerActionService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsDesignerActionService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="WebFormsDesignerActionService" FullName="System.Web.UI.Design.WebFormsDesignerActionService"> <TypeSignature Language="C#" Value="public class WebFormsDesignerActionService : System.ComponentModel.Design.DesignerActionService" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Establishes a design-time service that manages the collection of <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects for a component.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +27,13 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a new instance of the <see cref="T:System.Web.UI.Design.WebFormsDesignerActionService" /> class using the provided reference to the design host.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A reference to the design host.</param> </Docs> </Member> <Member MemberName="GetComponentDesignerActions"> @@ -42,11 +50,16 @@ <Parameter Name="actionLists" Type="System.ComponentModel.Design.DesignerActionListCollection" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="actionLists">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the smart-tag item lists that are associated with a component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />A reference to the control associated with the designer.</param> + <param name="actionLists"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.DesignerActionListCollection" /> to add the associated smart tags to.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsReferenceManager.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsReferenceManager.xml index f91be3af64f..e0eb9f696c4 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsReferenceManager.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsReferenceManager.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="WebFormsReferenceManager" FullName="System.Web.UI.Design.WebFormsReferenceManager"> <TypeSignature Language="C#" Value="public abstract class WebFormsReferenceManager" /> <AssemblyInfo> @@ -9,8 +10,27 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> base class is implemented by designer hosts to provide access to types, directives, and user controls defined in a Web project document. A control designer class can use the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> to access the definitions in the current document, and to add a new tag prefix to the current document.</para> + <para>You access the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> services supplied by the designer host through the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.ReferenceManager" /> property of a <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> implementation. The <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> implementation can be accessed in two ways:</para> + <list type="bullet"> + <item> + <para>Classes deriving from <see cref="T:System.Web.UI.Design.ControlDesigner" /> can use the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> property to access a <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> implementation supplied by the designer host. The <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> implementation is supplied through the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.ReferenceManager" /> property of <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> property.</para> + </item> + <item> + <para>Other designer classes can access the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> implementation by first obtaining the <see cref="T:System.ComponentModel.Design.IDesignerHost" /> services implementation through the designer component's <see cref="P:System.ComponentModel.Component.Site" />, and then calling the <see cref="M:System.ComponentModel.Design.IDesignerHost.GetDesigner(System.ComponentModel.IComponent)" /> method using the designer host <see cref="P:System.ComponentModel.Design.IDesignerHost.RootComponent" /> property.</para> + <block subset="none" type="note"> + <para> + <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> replaces the obsolete interface <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" />. Older designer hosts may only support the <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" /> interface implementation. Check that the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> and <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> implementations supplied by the designer host are not null to ensure the designer host implements the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> and <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> classes. </para> + </block> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base class for accessing the types, directives, and controls in the current Web project document. This class must be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +41,15 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Because the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class is abstract, you cannot create an instance of <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> directly using the constructor.</para> + <para>When deriving from the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class, override the constructor to implement custom initialization actions for your reference manager implementation.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="GetRegisterDirectives"> @@ -36,9 +63,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the register directives for the current project document.</para> + </summary> </Docs> </Member> <Member MemberName="GetTagPrefix"> @@ -54,10 +84,14 @@ <Parameter Name="objectType" Type="System.Type" /> </Parameters> <Docs> - <param name="objectType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the tag prefix for the specified object type.</para> + </summary> + <param name="objectType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the object.</param> </Docs> </Member> <Member MemberName="GetType"> @@ -74,11 +108,16 @@ <Parameter Name="tagName" Type="System.String" /> </Parameters> <Docs> - <param name="tagPrefix">To be added.</param> - <param name="tagName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the object type with the specified tag prefix and tag name.</para> + </summary> + <param name="tagPrefix"> + <attribution license="cc4" from="Microsoft" modified="false" />The tag prefix of the type to retrieve.</param> + <param name="tagName"> + <attribution license="cc4" from="Microsoft" modified="false" />The tag name of the type to retrieve.</param> </Docs> </Member> <Member MemberName="GetUserControlPath"> @@ -95,11 +134,20 @@ <Parameter Name="tagName" Type="System.String" /> </Parameters> <Docs> - <param name="tagPrefix">To be added.</param> - <param name="tagName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="M:System.Web.UI.Design.WebFormsReferenceManager.GetUserControlPath(System.String,System.String)" /> uses the tag prefix and name to locate the user control register directive in the current document, and returns the src attribute value defined in the register directive.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the relative URL path for the user control with the specified tag prefix and tag name.</para> + </summary> + <param name="tagPrefix"> + <attribution license="cc4" from="Microsoft" modified="false" />The tag prefix of the user control to retrieve.</param> + <param name="tagName"> + <attribution license="cc4" from="Microsoft" modified="false" />The tag name of the user control to retrieve.</param> </Docs> </Member> <Member MemberName="RegisterTagPrefix"> @@ -115,11 +163,18 @@ <Parameter Name="objectType" Type="System.Type" /> </Parameters> <Docs> - <param name="objectType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the tag prefix already exists, then a new register directive is not added.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a tag prefix for the specified type.</para> + </summary> + <param name="objectType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type to add a tag prefix for in the current document.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsRootDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsRootDesigner.xml index e96a1eaa074..1b7520eedc2 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsRootDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/WebFormsRootDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="WebFormsRootDesigner" FullName="System.Web.UI.Design.WebFormsRootDesigner"> <TypeSignature Language="C#" Value="public abstract class WebFormsRootDesigner : System.ComponentModel.Design.IDesignerFilter, System.ComponentModel.Design.IRootDesigner" /> <AssemblyInfo> @@ -16,8 +17,14 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A design host, such as vsprvslong, must provide its own derived version of the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> class to control designers through the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> property of the designer. Control designers use the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> property to access and manipulate the containing Web Forms page at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a base class for the design-time functionality of a Web Forms page and allows access to and manipulation of components and controls that are contained within the Web Forms page at design time. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -28,8 +35,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="AddClientScriptToDocument"> @@ -45,9 +55,13 @@ <Parameter Name="scriptItem" Type="System.Web.UI.Design.ClientScriptItem" /> </Parameters> <Docs> - <param name="scriptItem">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, adds a client script element to the current Web Forms page.</para> + </summary> + <param name="scriptItem"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ClientScriptItem" /> to add to the Web Forms page.</param> </Docs> </Member> <Member MemberName="AddControlToDocument"> @@ -65,12 +79,21 @@ <Parameter Name="location" Type="System.Web.UI.Design.ControlLocation" /> </Parameters> <Docs> - <param name="newControl">To be added.</param> - <param name="referenceControl">To be added.</param> - <param name="location">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Although a control might already have an ID assigned to it, if there is already a control in the Web Forms page with the same ID, a new ID is assigned.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, adds a Web server control to the Web Forms page.</para> + </summary> + <param name="newControl"> + <attribution license="cc4" from="Microsoft" modified="false" />The control to add to the Web Forms page.</param> + <param name="referenceControl"> + <attribution license="cc4" from="Microsoft" modified="false" />The control relative to which <paramref name="newControl" /> is added.</param> + <param name="location"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ControlLocation" /> value that indicates the location for <paramref name="newControl" /> relative to <paramref name="referenceControl" />.</param> </Docs> </Member> <Member MemberName="Component"> @@ -83,9 +106,15 @@ <ReturnType>System.ComponentModel.IComponent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.Component" /> property is set by the <see cref="M:System.Web.UI.Design.WebFormsRootDesigner.Initialize(System.ComponentModel.IComponent)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the component that this designer is designing.</para> + </summary> </Docs> </Member> <Member MemberName="CreateDesignerActionService"> @@ -101,10 +130,17 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebFormsRootDesigner.CreateDesignerActionService(System.IServiceProvider)" /> method is called by a control designer and provides a way for action items for the control designer to be implemented in the Web Forms page through a design host, such as vsprvslong.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a design-time <see cref="T:System.ComponentModel.Design.DesignerActionService" /> object.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />A design host, such as vsprvslong, cast as an <see cref="T:System.IServiceProvider" />.</param> </Docs> </Member> <Member MemberName="CreateUrlResolutionService"> @@ -118,9 +154,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an <see cref="T:System.Web.UI.IUrlResolutionService" /> that resolves relative URLs.</para> + </summary> </Docs> </Member> <Member MemberName="CurrentCulture"> @@ -133,9 +172,12 @@ <ReturnType>System.Globalization.CultureInfo</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the culture information for the current thread.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -151,9 +193,13 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources that are used by the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param> </Docs> </Member> <Member MemberName="DocumentUrl"> @@ -166,9 +212,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets the URL at which the Web Forms page is located. </para> + </summary> </Docs> </Member> <Member MemberName="Finalize"> @@ -182,8 +231,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Frees the resources of the current <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> object before it is reclaimed by the garbage collector.</para> + </summary> </Docs> </Member> <Member MemberName="GenerateEmptyDesignTimeHtml"> @@ -199,10 +251,17 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Web.UI.Design.WebFormsRootDesigner.GenerateEmptyDesignTimeHtml(System.Web.UI.Control)" /> method enables a consistent display of empty controls at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates empty HTML markup for a control at design time.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The control to generate HTML markup for.</param> </Docs> </Member> <Member MemberName="GenerateErrorDesignTimeHtml"> @@ -220,12 +279,18 @@ <Parameter Name="errorMessage" Type="System.String" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <param name="e">To be added.</param> - <param name="errorMessage">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates HTML markup that is used to display an error message at design time by using the specified control, exception, and message.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The control that raised the exception.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The exception. </param> + <param name="errorMessage"> + <attribution license="cc4" from="Microsoft" modified="false" />A message to add to the exception message.</param> </Docs> </Member> <Member MemberName="GetClientScriptsInDocument"> @@ -239,9 +304,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, returns a <see cref="T:System.Web.UI.Design.ClientScriptItemCollection" /> object that contains all client script items that are on the page.</para> + </summary> </Docs> </Member> <Member MemberName="GetControlViewAndTag"> @@ -279,10 +347,14 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <param name="serviceType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the requested service.</para> + </summary> + <param name="serviceType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of service to retrieve.</param> </Docs> </Member> <Member MemberName="GetView"> @@ -298,10 +370,14 @@ <Parameter Name="viewTechnology" Type="System.ComponentModel.Design.ViewTechnology" /> </Parameters> <Docs> - <param name="viewTechnology">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a view object that is determined by the provided <see cref="T:System.ComponentModel.Design.ViewTechnology" /> object.</para> + </summary> + <param name="viewTechnology"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.ViewTechnology" /> obtained from the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.SupportedTechnologies" /> property.</param> </Docs> </Member> <Member MemberName="Initialize"> @@ -317,9 +393,13 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> object using the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component that this designer is designing.</param> </Docs> </Member> <Member MemberName="IsDesignerViewLocked"> @@ -332,9 +412,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets a value indicating whether the designer view is locked.</para> + </summary> </Docs> </Member> <Member MemberName="IsLoading"> @@ -347,9 +430,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets a value indicating whether the Web Forms page is still loading.</para> + </summary> </Docs> </Member> <Member MemberName="LoadComplete"> @@ -362,8 +448,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when the designer completes loading the Web Forms page.</para> + </summary> </Docs> </Member> <Member MemberName="OnLoadComplete"> @@ -379,9 +468,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.Web.UI.Design.WebFormsRootDesigner.LoadComplete" /> event when the Web Forms page is completely loaded.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" />.</param> </Docs> </Member> <Member MemberName="PostFilterAttributes"> @@ -397,9 +490,13 @@ <Parameter Name="attributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="attributes">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to change or remove items from the set of attributes that the designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + </summary> + <param name="attributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The attributes for the class of the component.</param> </Docs> </Member> <Member MemberName="PostFilterEvents"> @@ -415,9 +512,13 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to change or remove items from the set of events that the designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />The events for the class of the component.</param> </Docs> </Member> <Member MemberName="PostFilterProperties"> @@ -433,9 +534,13 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to change or remove items from the set of properties that the designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The properties for the class of the component.</param> </Docs> </Member> <Member MemberName="PreFilterAttributes"> @@ -451,9 +556,13 @@ <Parameter Name="attributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="attributes">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to add to the set of attributes that the designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + </summary> + <param name="attributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The attributes for the class of the component.</param> </Docs> </Member> <Member MemberName="PreFilterEvents"> @@ -469,9 +578,13 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to add items to the set of events that the designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />The events for the class of the component.</param> </Docs> </Member> <Member MemberName="PreFilterProperties"> @@ -487,9 +600,13 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a designer to add items to the set of properties that the designer exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" /> object.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The properties for the class of the component.</param> </Docs> </Member> <Member MemberName="ReferenceManager"> @@ -502,9 +619,12 @@ <ReturnType>System.Web.UI.Design.WebFormsReferenceManager</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, gets a <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> object that has information about the current Web Forms page.</para> + </summary> </Docs> </Member> <Member MemberName="RemoveClientScriptFromDocument"> @@ -520,9 +640,13 @@ <Parameter Name="clientScriptId" Type="System.String" /> </Parameters> <Docs> - <param name="clientScriptId">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified client script from the document at design time.</para> + </summary> + <param name="clientScriptId"> + <attribution license="cc4" from="Microsoft" modified="false" />The identifier for the previously registered client script.</param> </Docs> </Member> <Member MemberName="RemoveControlFromDocument"> @@ -538,9 +662,13 @@ <Parameter Name="control" Type="System.Web.UI.Control" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When overridden in a derived class, removes the specified control from the Web Forms page.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The control to remove from the Web Forms page.</param> </Docs> </Member> <Member MemberName="ResolveUrl"> @@ -556,10 +684,14 @@ <Parameter Name="relativeUrl" Type="System.String" /> </Parameters> <Docs> - <param name="relativeUrl">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts a relative URL into a fully qualified URL.</para> + </summary> + <param name="relativeUrl"> + <attribution license="cc4" from="Microsoft" modified="false" />A relative URL for a resource on the site.</param> </Docs> </Member> <Member MemberName="SetControlID"> @@ -576,10 +708,15 @@ <Parameter Name="id" Type="System.String" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <param name="id">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the ID property of the specified control with the specified string.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The control on which to set the ID.</param> + <param name="id"> + <attribution license="cc4" from="Microsoft" modified="false" />The string to set as the ID for the control.</param> </Docs> </Member> <Member MemberName="SupportedTechnologies"> @@ -592,9 +729,12 @@ <ReturnType>System.ComponentModel.Design.ViewTechnology[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array of technologies that the designer component can support for its display.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesigner.DoDefaultAction"> @@ -608,8 +748,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.IDesigner.DoDefaultAction" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesigner.Verbs"> @@ -622,9 +768,15 @@ <ReturnType>System.ComponentModel.Design.DesignerVerbCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the design-time verbs that are supported by the designer. For a description of this member, see <see cref="P:System.ComponentModel.Design.IDesigner.Verbs" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PostFilterAttributes"> @@ -640,9 +792,16 @@ <Parameter Name="attributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="attributes">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.IDesignerFilter.PostFilterAttributes(System.Collections.IDictionary)" />.</para> + </summary> + <param name="attributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The attribute objects for the class of the component.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PostFilterEvents"> @@ -658,9 +817,16 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.IDesignerFilter.PostFilterEvents(System.Collections.IDictionary)" />.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />The event descriptor objects that represent the events of the class of the component. The keys in the dictionary of events are event names.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PostFilterProperties"> @@ -676,9 +842,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.IDesignerFilter.PostFilterProperties(System.Collections.IDictionary)" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The property descriptor objects that represent the properties of the class of the component. The keys in the dictionary of properties are property names.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PreFilterAttributes"> @@ -694,9 +867,16 @@ <Parameter Name="attributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="attributes">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.IDesignerFilter.PreFilterAttributes(System.Collections.IDictionary)" />.</para> + </summary> + <param name="attributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The attribute objects for the class of the component.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PreFilterEvents"> @@ -712,9 +892,16 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="events">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.IDesignerFilter.PreFilterEvents(System.Collections.IDictionary)" />.</para> + </summary> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />The event descriptor objects that represent the events of the class of the component. The keys in the dictionary of events are event names.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IDesignerFilter.PreFilterProperties"> @@ -730,9 +917,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.IDesignerFilter.PreFilterProperties(System.Collections.IDictionary)" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />The property descriptor objects that represent the properties of the class of the component. The keys in the dictionary of properties are property names.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IRootDesigner.GetView"> @@ -748,10 +942,17 @@ <Parameter Name="viewTechnology" Type="System.ComponentModel.Design.ViewTechnology" /> </Parameters> <Docs> - <param name="viewTechnology">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IRootDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a view object for the specified view technology. For a description of this member, see <see cref="M:System.ComponentModel.Design.IRootDesigner.GetView(System.ComponentModel.Design.ViewTechnology)" />.</para> + </summary> + <param name="viewTechnology"> + <attribution license="cc4" from="Microsoft" modified="false" /> The view technology.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IRootDesigner.SupportedTechnologies"> @@ -764,9 +965,15 @@ <ReturnType>System.ComponentModel.Design.ViewTechnology[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IRootDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array of technologies that the designer component can support for its display. For a description of this member, see <see cref="P:System.ComponentModel.Design.IRootDesigner.SupportedTechnologies" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.IDisposable.Dispose"> @@ -780,8 +987,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> instance is cast to an <see cref="T:System.IDisposable" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.IDisposable.Dispose" />.</para> + </summary> </Docs> </Member> <Member MemberName="Verbs"> @@ -794,10 +1007,18 @@ <ReturnType>System.ComponentModel.Design.DesignerVerbCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>Typically, a design-time environment provides a <ui>Properties</ui> command on a shortcut menu for a component. Therefore, do not include a similar entry in the collection of designer-specified verbs.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the design-time verbs that are supported by the designer.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlDataFileEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlDataFileEditor.xml index d73ffa58f93..5a31924a889 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlDataFileEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlDataFileEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="XmlDataFileEditor" FullName="System.Web.UI.Design.XmlDataFileEditor"> <TypeSignature Language="C#" Value="public class XmlDataFileEditor : System.Web.UI.Design.UrlEditor" /> <AssemblyInfo> @@ -9,8 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> object is used at design time to select and edit a URL for an XML data file (.xml), and then assign the URL to a control property. For example, the <see cref="T:System.Web.UI.WebControls.XmlDataSource" /> control uses the <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> class at design time to set the value of the <see cref="P:System.Web.UI.WebControls.XmlDataSource.DataFile" /> property.</para> + <para>Use the <see cref="T:System.ComponentModel.EditorAttribute" /> attribute to associate the <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> with a property. When the associated property is edited on the design surface, the designer host calls the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method. The <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method uses the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The <see cref="Overload:System.Web.UI.Design.UrlEditor.GetEditStyle" /> method indicates the display style of the user interface.</para> + <para>Derive a class from the <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> to define a custom editor for an XML data property. For example, a derived class can override the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method, and then call the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method with a custom <see cref="P:System.Web.UI.Design.XmlDataFileEditor.Filter" /> or <see cref="P:System.Web.UI.Design.XmlDataFileEditor.Caption" /> value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a design-time user interface for selecting an XML data file.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +30,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="Caption"> @@ -35,9 +47,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.XmlDataFileEditor.Caption" /> property is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption to display on the selection dialog box.</para> + </summary> </Docs> </Member> <Member MemberName="Filter"> @@ -50,10 +68,22 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.XmlDataFileEditor.Filter" /> property is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para> + <para>The <see cref="P:System.Web.UI.Design.XmlDataFileEditor.Filter" /> property default value indicates two URL filters for the dialog box: one for XML data files (*.xml) and another for all files (*.*).</para> + <para>A filter string contains one or more filter options. Each filter option contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. </para> + <para>The following is an example of a filter string that contains two filter options: </para> + <para>"XML Files (*.xml)|*.xml|All Files (*.*)|*.*".</para> + <para>You can specify several filter patterns in a filter option by separating the filter patterns with semicolons. The following is an example of a filter string in which the first filter option specifies two filter patterns: </para> + <para>"Custom XML Files (*.xd1; *.xd2)|*.xd1;*.xd2|All Files (*.*)|*.*".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the URL filter options for the editor, which is used to filter the items that appear in the URL selection dialog box.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlDocumentSchema.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlDocumentSchema.xml index 6b3d42eb111..96806c5e1d7 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlDocumentSchema.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlDocumentSchema.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="XmlDocumentSchema" FullName="System.Web.UI.Design.XmlDocumentSchema"> <TypeSignature Language="C#" Value="public sealed class XmlDocumentSchema : System.Web.UI.Design.IDataSourceSchema" /> <AssemblyInfo> @@ -13,8 +14,14 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Web.UI.Design.XmlDocumentSchema" /> class is used by custom control designer components to list the structural elements of an XML document at design time. Use the XmlDocumentSchema class to populate lists of document elements to allow users to select document elements in UI features at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the structure, or schema, of an <see cref="T:System.Xml.XmlDocument" />. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -28,10 +35,18 @@ <Parameter Name="xPath" Type="System.String" /> </Parameters> <Docs> - <param name="xmlDocument">To be added.</param> - <param name="xPath">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Use the <paramref name="xPath" /> parameter to specify either a specific node within the XML document to examine, or specify the empty string ("") to examine the complete document.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates an instance of the <see cref="T:System.Web.UI.Design.XmlDocumentSchema" /> class using a specified <see cref="T:System.Xml.XmlDocument" /> and an XPath string.</para> + </summary> + <param name="xmlDocument"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of an <see cref="T:System.Xml.XmlDocument" /> object.</param> + <param name="xPath"> + <attribution license="cc4" from="Microsoft" modified="false" />An XPath string identifying the child nodes of the document root.</param> </Docs> </Member> <Member MemberName="GetViews"> @@ -45,10 +60,13 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array containing information about each child node starting at the node identified by the <paramref name="xPath" /> parameter in the constructor, or each child node starting at the document root if the <paramref name="xPath" /> parameter is empty.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlFileEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlFileEditor.xml index 24f8390252b..c87ee926ab7 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlFileEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlFileEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="XmlFileEditor" FullName="System.Web.UI.Design.XmlFileEditor"> <TypeSignature Language="C#" Value="public class XmlFileEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.XmlFileEditor" /> is a <see cref="T:System.Drawing.Design.UITypeEditor" /> that provides a dialog for selecting an XML file for a file name property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for selecting an XML file using a standard <see cref="T:System.Windows.Forms.OpenFileDialog" /> box.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.XmlFileEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,12 +50,21 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A service provider is provided so that any required editing services can be obtained.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the specified object using the specified service provider and context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which editing services may be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the value being edited. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,10 +81,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editing style associated with this editor, using the specified <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -72,4 +96,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlUrlEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlUrlEditor.xml index 985d01be641..9ea5ca505ce 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlUrlEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XmlUrlEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="XmlUrlEditor" FullName="System.Web.UI.Design.XmlUrlEditor"> <TypeSignature Language="C#" Value="public class XmlUrlEditor : System.Web.UI.Design.UrlEditor" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.XmlUrlEditor" /> is a <see cref="T:System.Drawing.Design.UITypeEditor" /> that provides a dialog for selecting a URL that indicates the location of an XML file.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for selecting a URL that indicates the location of an XML file.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes an instance of the <see cref="T:System.Web.UI.Design.XmlUrlEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +45,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption to display on the selection dialog window.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -50,9 +64,18 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.XmlUrlEditor.Filter" /> property specifies a filter string with two filter options: one for XML files (*.xml), and one for all files (*.*).</para> + <para>A filter string contains one or more filter options. Each filter option contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. </para> + <para>The following is an example of a filter string that contains two filter options: "XML Files (*.xml)|*.xml|All Files (*.*)|*.*".</para> + <para>You can specify several filter patterns in a filter option by separating the filter patterns with semicolons. The following is an example of a filter string in which the first filter option specifies two filter patterns: "Custom XML Files (*.xml;*.xlst)|*.xml;*.xlst|All Files (*.*)|*.*".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the file name filter string for the editor. This is used to determine the items that appear in the file list of the dialog box.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -66,9 +89,12 @@ <ReturnType>System.Web.UI.Design.UrlBuilderOptions</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the options for the URL builder to use.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -76,4 +102,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XsdSchemaFileEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XsdSchemaFileEditor.xml index 38ed640d4be..6fc0b36d23a 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XsdSchemaFileEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XsdSchemaFileEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="XsdSchemaFileEditor" FullName="System.Web.UI.Design.XsdSchemaFileEditor"> <TypeSignature Language="C#" Value="public class XsdSchemaFileEditor : System.Web.UI.Design.UrlEditor" /> <AssemblyInfo> @@ -9,8 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An <see cref="T:System.Web.UI.Design.XsdSchemaFileEditor" /> object is used at design time to select and edit a URL for an XML schema definition file (.xsd), and to assign the URL to a control property.</para> + <para>Use the <see cref="T:System.ComponentModel.EditorAttribute" /> attribute to associate the <see cref="T:System.Web.UI.Design.XsdSchemaFileEditor" /> with a property. When the associated property is edited on the design surface, the designer host calls the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method. The <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method uses the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The <see cref="Overload:System.Web.UI.Design.UrlEditor.GetEditStyle" /> method indicates the display style of the user interface.</para> + <para>Derive a class from the <see cref="T:System.Web.UI.Design.XsdSchemaFileEditor" /> to define a custom editor for an XML schema URL property. For example, a derived class can override the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method, and then call the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method with a custom <see cref="P:System.Web.UI.Design.XsdSchemaFileEditor.Filter" /> or <see cref="P:System.Web.UI.Design.XsdSchemaFileEditor.Caption" /> value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a design-time user interface for selecting an XML schema definition file.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +30,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.XsdSchemaFileEditor" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="Caption"> @@ -35,9 +47,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.XsdSchemaFileEditor.Caption" /> property is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption to display on the selection dialog box.</para> + </summary> </Docs> </Member> <Member MemberName="Filter"> @@ -50,10 +68,23 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.XsdSchemaFileEditor.Filter" /> property is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para> + <para>The <see cref="P:System.Web.UI.Design.XsdSchemaFileEditor.Filter" /> property default value indicates two URL filters for the dialog box: one for XML schema definition files (*.xsd) and another for all files (*.*).</para> + <para>To specify a custom filter string, derive a class from the <see cref="T:System.Web.UI.Design.XsdSchemaFileEditor" /> class, and then override the <see cref="P:System.Web.UI.Design.XsdSchemaFileEditor.Filter" /> property to return the custom filter string.</para> + <para>A filter string contains one or more filter options. Each filter option contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. </para> + <para>The following is an example of a filter string that contains two filter options: </para> + <para>"XML Schema Files (*.xsd)|*.xsd|All Files (*.*)|*.*".</para> + <para>You can specify several filter patterns in a filter option by separating the filter patterns with semicolons. The following is an example of a filter string in which the first filter option specifies two filter patterns: </para> + <para>"Custom Schema Files (*.xs1; *.xs2)|*.xs1;*.xs2|All Files (*.*)|*.*".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the URL filter options for the editor, which are used to filter the items that appear in the URL selection dialog box.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XslTransformFileEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XslTransformFileEditor.xml index ad0cfc6099c..63d736e7ff7 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XslTransformFileEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XslTransformFileEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="XslTransformFileEditor" FullName="System.Web.UI.Design.XslTransformFileEditor"> <TypeSignature Language="C#" Value="public class XslTransformFileEditor : System.Web.UI.Design.UrlEditor" /> <AssemblyInfo> @@ -9,8 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An <see cref="T:System.Web.UI.Design.XslTransformFileEditor" /> object is used at design time to select and edit a URL for a XML transform file (.xsl) and to assign the URL to a control property. For example, the <see cref="T:System.Web.UI.WebControls.XmlDataSource" /> control uses the <see cref="T:System.Web.UI.Design.XslTransformFileEditor" /> class at design time to set the value of the <see cref="P:System.Web.UI.WebControls.XmlDataSource.TransformFile" /> property.</para> + <para>Use the <see cref="T:System.ComponentModel.EditorAttribute" /> attribute to associate the <see cref="T:System.Web.UI.Design.XslTransformFileEditor" /> with a property. When the associated property is edited on the design surface, the designer host calls the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method. The <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method uses the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The <see cref="Overload:System.Web.UI.Design.UrlEditor.GetEditStyle" /> method indicates the display style of the user interface.</para> + <para>Derive a class from the <see cref="T:System.Web.UI.Design.XslTransformFileEditor" /> to define a custom editor for an XML transform file URL property. For example, a derived class can override the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method, and then call the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method with a custom <see cref="P:System.Web.UI.Design.XslTransformFileEditor.Filter" /> or <see cref="P:System.Web.UI.Design.XslTransformFileEditor.Caption" /> value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a design-time user interface for selecting an XML transform file.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +30,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.XslTransformFileEditor" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="Caption"> @@ -35,9 +47,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.XslTransformFileEditor.Caption" /> property is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption to display on the selection dialog box.</para> + </summary> </Docs> </Member> <Member MemberName="Filter"> @@ -50,10 +68,23 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.XslTransformFileEditor.Filter" /> property is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para> + <para>The <see cref="P:System.Web.UI.Design.XslTransformFileEditor.Filter" /> property default value indicates two URL filters for the dialog box: one for XML transform files (*.xsl) and another for all files (*.*).</para> + <para>To specify a custom filter string, derive a class from the <see cref="T:System.Web.UI.Design.XslTransformFileEditor" /> class, and then override the <see cref="P:System.Web.UI.Design.XslTransformFileEditor.Filter" /> property to return the custom filter string.</para> + <para>A filter string contains one or more filter options. Each filter option contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. </para> + <para>Following is an example of a filter string that contains two filter options: </para> + <para>"XML Transform Files (*.xsl)|*.xsl|All Files (*.*)|*.*".</para> + <para>You can specify several filter patterns in a filter option by separating the filter patterns with semicolons. Following is an example of a filter string in which the first filter option specifies two filter patterns: </para> + <para>"Custom XML Transform Files (*.xs1; *.xs2)|*.xs1;*.xs2|All Files (*.*)|*.*".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the URL filter options for the editor, which is used to filter the items that appear in the URL selection dialog box.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XslUrlEditor.xml b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XslUrlEditor.xml index 152fa9b5546..75b1a735f25 100644 --- a/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XslUrlEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/XslUrlEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="XslUrlEditor" FullName="System.Web.UI.Design.XslUrlEditor"> <TypeSignature Language="C#" Value="public class XslUrlEditor : System.Web.UI.Design.UrlEditor" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Web.UI.Design.XslUrlEditor" /> is a <see cref="T:System.Drawing.Design.UITypeEditor" /> that provides a dialog for selecting a URL that indicates the location of an XSL file.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for selecting an URL that indicates the location of an XSL file.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes an instance of the <see cref="T:System.Web.UI.Design.XslUrlEditor" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,9 +45,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the caption to display on the selection dialog window.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -50,9 +64,18 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Web.UI.Design.XslUrlEditor.Filter" /> property specifies a filter string with two filter options: one for XSL files (*.xsl;*.xslt), and one for all files (*.*).</para> + <para>A filter string contains one or more filter options. Each filter option contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. </para> + <para>The following is an example of a filter string that contains two filter options: "XSLT Files (*.xslt)|*.xslt|All Files (*.*)|*.*".</para> + <para>You can specify several filter patterns in a filter option by separating the filter patterns with semicolons. The following is an example of a filter string in which the first filter option specifies two filter patterns: "XSL Files (*.xslt;*.xsl)|*.xslt;*.xsl|All Files (*.*)|*.*".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the file name filter string for the editor. This is used to determine the items that appear in the file list of the dialog box.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -66,9 +89,12 @@ <ReturnType>System.Web.UI.Design.UrlBuilderOptions</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the options for the URL builder to use.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -76,4 +102,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Adorner.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Adorner.xml index d06b1ced1d8..4dcfa2a7660 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Adorner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Adorner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="Adorner" FullName="System.Windows.Forms.Design.Behavior.Adorner"> <TypeSignature Language="C#" Value="public sealed class Adorner" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Each <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> can be enabled and disabled. Only enabled <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> objects will receive hit test and paint messages from the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. An <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> can be viewed as a proxy between user-interface related elements, which consist of all <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects, and the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + <para>For more information, see <format type="text/html"><a href="7c60cc41-4324-46b5-b444-b39eda7cb33f">Behavior Service Overview</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Manages a collection of user-interface related <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +29,14 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Adorner.#ctor" /> constructor creates a new <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" /> and is enabled, by default.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="BehaviorService"> @@ -35,9 +49,15 @@ <ReturnType>System.Windows.Forms.Design.Behavior.BehaviorService</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When an <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> is added to the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />, the collection sets this property so that the <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> can call back to the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> associated with the <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" />. </para> + </summary> </Docs> </Member> <Member MemberName="Enabled"> @@ -50,9 +70,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="P:System.Windows.Forms.Design.Behavior.Adorner.Enabled" /> property is true, the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> class will send HitTest and Paint messages to the <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value indicating if the <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> is enabled.</para> + </summary> </Docs> </Member> <Member MemberName="Glyphs"> @@ -65,9 +91,12 @@ <ReturnType>System.Windows.Forms.Design.Behavior.GlyphCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> collection.</para> + </summary> </Docs> </Member> <Member MemberName="Invalidate"> @@ -81,8 +110,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Forces the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> to refresh its adorner window.</para> + </summary> </Docs> </Member> <Member MemberName="Invalidate"> @@ -98,9 +130,13 @@ <Parameter Name="rectangle" Type="System.Drawing.Rectangle" /> </Parameters> <Docs> - <param name="rectangle">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Forces the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> to refresh its adorner window within the given <see cref="T:System.Drawing.Rectangle" />.</para> + </summary> + <param name="rectangle"> + <attribution license="cc4" from="Microsoft" modified="false" />The area to invalidate.</param> </Docs> </Member> <Member MemberName="Invalidate"> @@ -116,10 +152,14 @@ <Parameter Name="region" Type="System.Drawing.Region" /> </Parameters> <Docs> - <param name="region">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Forces the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> to refresh its adorner window within the given <see cref="T:System.Drawing.Region" />.</para> + </summary> + <param name="region"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Region" /> to invalidate.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Behavior.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Behavior.xml index 6353a170f11..0bc3b2718ac 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Behavior.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Behavior.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="Behavior" FullName="System.Windows.Forms.Design.Behavior.Behavior"> <TypeSignature Language="C#" Value="public abstract class Behavior" /> <AssemblyInfo> @@ -9,8 +10,18 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This class can be extended to develop any type of user interface behavior, including selection, drag, and resize behaviors.</para> + <para>For more information, see <format type="text/html"><a href="7c60cc41-4324-46b5-b444-b39eda7cb33f">Behavior Service Overview</a></format>.</para> + <block subset="none" type="note"> + <para>Your <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> type must be associated with a <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> type. Glyph-independent behaviors are not supported.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> objects that are managed by a <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +32,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.Behavior.Behavior" /> class. </para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -36,10 +50,20 @@ <Parameter Name="behaviorService" Type="System.Windows.Forms.Design.Behavior.BehaviorService" /> </Parameters> <Docs> - <param name="callParentBehavior">To be added.</param> - <param name="behaviorService">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The parent behavior is the next behavior on the behavior stack maintained by the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. If the <paramref name="callParentBehavior" /> parameter is true, then the <paramref name="behaviorService" /> parameter must not be null.</para> + <para> + <paramref name="callParentBehavior" /> indicates whether the base <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> class should call the parent behavior, and then allow the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> select the correct parent behavior.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> class with the given <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="callParentBehavior"> + <attribution license="cc4" from="Microsoft" modified="false" />true if the parent behavior should be called if it exists; otherwise, false.</param> + <param name="behaviorService"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> to use.</param> </Docs> </Member> <Member MemberName="Cursor"> @@ -52,9 +76,12 @@ <ReturnType>System.Windows.Forms.Cursor</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the cursor that should be displayed for this behavior.</para> + </summary> </Docs> </Member> <Member MemberName="DisableAllCommands"> @@ -67,9 +94,54 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A true value for the <see cref="P:System.Windows.Forms.Design.Behavior.Behavior.DisableAllCommands" /> property indicates to the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> that all <see cref="T:System.ComponentModel.Design.MenuCommand" /> objects the designer receives should have their state disabled when this behavior is active.</para> + <para>The <see cref="P:System.Windows.Forms.Design.Behavior.Behavior.DisableAllCommands" /> property works in conjunction with the <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.FindCommand(System.ComponentModel.Design.CommandID)" /> method so you can customize the interaction between glyphs and behaviors. The following table summarizes the results of a call to <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.FindCommand(System.ComponentModel.Design.CommandID)" /> for a particular <see cref="T:System.ComponentModel.Design.MenuCommand" />.</para> + <list type="table"> + <item> + <term> + <para> </para> + </term> + <description> + <para> + <see cref="P:System.Windows.Forms.Design.Behavior.Behavior.DisableAllCommands" /> is true</para> + </description> + <description> + <para> + <see cref="P:System.Windows.Forms.Design.Behavior.Behavior.DisableAllCommands" /> is false</para> + </description> + </item> + <item> + <term> + <para>Hit-tested glyph has an assigned behavior</para> + </term> + <description> + <para>If the <see cref="T:System.ComponentModel.Design.MenuCommand" /> with the specified <paramref name="command ID" /> is found in the <see cref="T:System.ComponentModel.Design.IMenuCommandService" />, that <see cref="T:System.ComponentModel.Design.MenuCommand" /> is disabled and returned. Otherwise, null is returned.</para> + </description> + <description> + <para> + <see cref="Overload:System.ComponentModel.Design.MenuCommandService.FindCommand" /> is called on the behavior and, if found, the behavior’s <see cref="T:System.ComponentModel.Design.MenuCommand" /> is returned. Otherwise, the result of <see cref="M:System.ComponentModel.Design.IMenuCommandService.FindCommand(System.ComponentModel.Design.CommandID)" /> with the specified <paramref name="command ID" /> is returned.</para> + </description> + </item> + <item> + <term> + <para>Hit-tested glyph has no assigned behavior</para> + </term> + <description> + <para>The result of <see cref="M:System.ComponentModel.Design.IMenuCommandService.FindCommand(System.ComponentModel.Design.CommandID)" /> with the specified <paramref name="command ID" /> is returned.</para> + </description> + <description> + <para>The result of <see cref="M:System.ComponentModel.Design.IMenuCommandService.FindCommand(System.ComponentModel.Design.CommandID)" /> with the specified <paramref name="command ID" /> is returned.</para> + </description> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether <see cref="T:System.ComponentModel.Design.MenuCommand" /> objects should be disabled.</para> + </summary> </Docs> </Member> <Member MemberName="FindCommand"> @@ -85,10 +157,17 @@ <Parameter Name="commandId" Type="System.ComponentModel.Design.CommandID" /> </Parameters> <Docs> - <param name="commandId">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.FindCommand(System.ComponentModel.Design.CommandID)" /> method is called from the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. It provides an opportunity for the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> to return its own custom <see cref="T:System.ComponentModel.Design.MenuCommand" />, thereby intercepting this message.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Intercepts commands.</para> + </summary> + <param name="commandId"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.CommandID" /> object.</param> </Docs> </Member> <Member MemberName="OnDragDrop"> @@ -105,10 +184,15 @@ <Parameter Name="e" Type="System.Windows.Forms.DragEventArgs" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Permits custom drag-and-drop behavior.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> object on which to invoke drag-and-drop behavior.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DragEventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="OnDragEnter"> @@ -125,10 +209,15 @@ <Parameter Name="e" Type="System.Windows.Forms.DragEventArgs" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Permits custom drag-enter behavior.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> on which to invoke drag-enter behavior.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DragEventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="OnDragLeave"> @@ -145,10 +234,15 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Permits custom drag-leave behavior.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> on which to invoke drag-leave behavior.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DragEventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="OnDragOver"> @@ -165,10 +259,15 @@ <Parameter Name="e" Type="System.Windows.Forms.DragEventArgs" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Permits custom drag-over behavior.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> on which to invoke drag-over behavior.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DragEventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="OnGiveFeedback"> @@ -185,10 +284,15 @@ <Parameter Name="e" Type="System.Windows.Forms.GiveFeedbackEventArgs" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Permits custom drag-and-drop feedback behavior.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> on which to invoke drag-and-drop behavior.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.GiveFeedbackEventArgs" /> that contains the event data.</param> </Docs> </Member> <Member MemberName="OnLoseCapture"> @@ -205,10 +309,30 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A behavior can request mouse capture through the behavior service by pushing itself onto the behavior stack with the <see cref="M:System.Windows.Forms.Design.Behavior.BehaviorService.PushCaptureBehavior(System.Windows.Forms.Design.Behavior.Behavior)" /> method. If it does so, it will be notified through the <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnLoseCapture(System.Windows.Forms.Design.Behavior.Glyph,System.EventArgs)" /> method when capture is lost. Generally the behavior removes itself from the stack at this time. Capture is lost when one of the following actions occurs:</para> + <list type="bullet"> + <item> + <para>Someone else requests capture.</para> + </item> + <item> + <para>Another behavior is pushed.</para> + </item> + <item> + <para>This behavior is removed.</para> + </item> + </list> + <para>In each of these cases, <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnLoseCapture(System.Windows.Forms.Design.Behavior.Glyph,System.EventArgs)" /> will be called on the behavior.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called by the adorner window when it loses mouse capture.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> on which to invoke drag-and-drop behavior.</param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="OnMouseDoubleClick"> @@ -226,12 +350,21 @@ <Parameter Name="mouseLoc" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="button">To be added.</param> - <param name="mouseLoc">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnMouseDoubleClick(System.Windows.Forms.Design.Behavior.Glyph,System.Windows.Forms.MouseButtons,System.Drawing.Point)" /> method is called when any double-click message enters the WndProc of the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. The message is first passed here, to the top-most <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> in the behavior stack. Returning true from this method signifies that the message was handled by the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> and should not continue to be processed. From here, the message is sent to the appropriate behavior.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when any double-click message enters the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</param> + <param name="button"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseButtons" /> value indicating which button was clicked.</param> + <param name="mouseLoc"> + <attribution license="cc4" from="Microsoft" modified="false" />The location at which the click occurred. </param> </Docs> </Member> <Member MemberName="OnMouseDown"> @@ -249,12 +382,21 @@ <Parameter Name="mouseLoc" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="button">To be added.</param> - <param name="mouseLoc">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnMouseDoubleClick(System.Windows.Forms.Design.Behavior.Glyph,System.Windows.Forms.MouseButtons,System.Drawing.Point)" /> method is called when any mouse-down message enters the WndProc of the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. The message is first passed here, to the top-most <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> in the behavior stack. Returning true from this method signifies that the message was handled by the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> and should not continue to be processed. From here, the message is sent to the appropriate behavior.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when any mouse-down message enters the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />. </param> + <param name="button"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseButtons" /> value indicating which button was clicked.</param> + <param name="mouseLoc"> + <attribution license="cc4" from="Microsoft" modified="false" />The location at which the click occurred. </param> </Docs> </Member> <Member MemberName="OnMouseEnter"> @@ -270,10 +412,18 @@ <Parameter Name="g" Type="System.Windows.Forms.Design.Behavior.Glyph" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnMouseDoubleClick(System.Windows.Forms.Design.Behavior.Glyph,System.Windows.Forms.MouseButtons,System.Drawing.Point)" /> method is called when any mouse-enter message enters the WndProc of the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. From here, the message is sent to the appropriate behavior.</para> + <para>When the mouse pointer's location is positively hit-tested with a different <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> than previous hit tests, this method is called on the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> associated with the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when any mouse-enter message enters the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />. </param> </Docs> </Member> <Member MemberName="OnMouseHover"> @@ -290,11 +440,19 @@ <Parameter Name="mouseLoc" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="mouseLoc">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnMouseDoubleClick(System.Windows.Forms.Design.Behavior.Glyph,System.Windows.Forms.MouseButtons,System.Drawing.Point)" /> method is called when any mouse-hover message enters the WndProc of the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. The message is first passed here, to the top-most <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> in the behavior stack. Returning true from this method signifies that the message was handled by the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> and should not continue to be processed. From here, the message is sent to the appropriate behavior.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when any mouse-hover message enters the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />. </param> + <param name="mouseLoc"> + <attribution license="cc4" from="Microsoft" modified="false" />The location at which the hover occurred. </param> </Docs> </Member> <Member MemberName="OnMouseLeave"> @@ -310,10 +468,18 @@ <Parameter Name="g" Type="System.Windows.Forms.Design.Behavior.Glyph" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnMouseDoubleClick(System.Windows.Forms.Design.Behavior.Glyph,System.Windows.Forms.MouseButtons,System.Drawing.Point)" /> method is called when any mouse-leave message enters the WndProc of the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. From here, the message is sent to the appropriate behavior.</para> + <para>When the mouse pointer leaves a positively hit-tested <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> with a valid <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" />, this method is invoked.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when any mouse-leave message enters the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</param> </Docs> </Member> <Member MemberName="OnMouseMove"> @@ -331,12 +497,21 @@ <Parameter Name="mouseLoc" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="button">To be added.</param> - <param name="mouseLoc">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnMouseDoubleClick(System.Windows.Forms.Design.Behavior.Glyph,System.Windows.Forms.MouseButtons,System.Drawing.Point)" /> method is called when any mouse-move message enters the WndProc of the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. The message is first passed here, to the top-most <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> in the behavior stack. Returning true from this method signifies that the message was handled by the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> and should not continue to be processed. From here, the message is sent to the appropriate behavior.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when any mouse-move message enters the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />. </param> + <param name="button"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseButtons" /> value indicating which button was clicked.</param> + <param name="mouseLoc"> + <attribution license="cc4" from="Microsoft" modified="false" />The location at which the move occurred. </param> </Docs> </Member> <Member MemberName="OnMouseUp"> @@ -353,11 +528,19 @@ <Parameter Name="button" Type="System.Windows.Forms.MouseButtons" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="button">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnMouseDoubleClick(System.Windows.Forms.Design.Behavior.Glyph,System.Windows.Forms.MouseButtons,System.Drawing.Point)" /> method is called when any mouse-up message enters the WndProc of the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. The message is first passed here, to the top-most <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> in the behavior stack. Returning true from this method signifies that the message was handled by the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> and should not continue to be processed. From here, the message is sent to the appropriate behavior.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when any mouse-up message enters the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />. </param> + <param name="button"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseButtons" /> value indicating which button was clicked.</param> </Docs> </Member> <Member MemberName="OnQueryContinueDrag"> @@ -374,11 +557,16 @@ <Parameter Name="e" Type="System.Windows.Forms.QueryContinueDragEventArgs" /> </Parameters> <Docs> - <param name="g">To be added.</param> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sends this drag-and-drop event from the adorner window to the appropriate <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> or hit-tested <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </summary> + <param name="g"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />. </param> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.QueryContinueDragEventArgs" /> that contains the event data. </param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorDragDropEventArgs.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorDragDropEventArgs.xml index bf30c06ca3b..7b9ae97a99c 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorDragDropEventArgs.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorDragDropEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BehaviorDragDropEventArgs" FullName="System.Windows.Forms.Design.Behavior.BehaviorDragDropEventArgs"> <TypeSignature Language="C#" Value="public class BehaviorDragDropEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:System.Windows.Forms.Design.Behavior.BehaviorService.BeginDrag" /> and <see cref="E:System.Windows.Forms.Design.Behavior.BehaviorService.EndDrag" /> events.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +27,13 @@ <Parameter Name="dragComponents" Type="System.Collections.ICollection" /> </Parameters> <Docs> - <param name="dragComponents">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.BehaviorDragDropEventArgs" /> class.</para> + </summary> + <param name="dragComponents"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Collections.ICollection" /> of <see cref="T:System.ComponentModel.IComponent" /> objects currently being dragged.</param> </Docs> </Member> <Member MemberName="DragComponents"> @@ -38,10 +46,13 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the list of <see cref="T:System.ComponentModel.IComponent" /> objects currently being dragged.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorDragDropEventHandler.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorDragDropEventHandler.xml index e724d956747..24725669dbd 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorDragDropEventHandler.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorDragDropEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BehaviorDragDropEventHandler" FullName="System.Windows.Forms.Design.Behavior.BehaviorDragDropEventHandler"> <TypeSignature Language="C#" Value="public delegate void BehaviorDragDropEventHandler(object sender, BehaviorDragDropEventArgs e);" /> <AssemblyInfo> @@ -17,7 +18,13 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When you create a <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorDragDropEventHandler" /> delegate, you identify a method to handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see <format type="text/html"><a href="d98fd58b-fa4f-4598-8378-addf4355a115">Events and Delegates</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the methods that will handle the <see cref="E:System.Windows.Forms.Design.Behavior.BehaviorService.BeginDrag" /> and <see cref="E:System.Windows.Forms.Design.Behavior.BehaviorService.EndDrag" /> events of a <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. This class cannot be inherited.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorService.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorService.xml index 6697c06f1a6..953807914c3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BehaviorService" FullName="System.Windows.Forms.Design.Behavior.BehaviorService"> <TypeSignature Language="C#" Value="public sealed class BehaviorService : IDisposable" /> <AssemblyInfo> @@ -13,8 +14,16 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>When the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> is created, it adds a transparent window over the designer frame. The <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> can then use this window to render user interface elements, called <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects, as well as catch all mouse messages. In this way, the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> can control designer behavior. </para> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> class supports a behavior stack, onto which <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> objects can be pushed. When a message is intercepted through the transparent window, the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> can send the message to the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> at the top of the stack. This enables different user interface modes depending on the currently pushed <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" />. The <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> is used to render all <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects, such as selection borders, sizing handles, and smart tags. The <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> also controls many design-time behaviors, such as using snaplines, dragging, and selecting.</para> + <para>For more information, see <format type="text/html"><a href="7c60cc41-4324-46b5-b444-b39eda7cb33f">Behavior Service Overview</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Manages user interface in the designer. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName="Adorners"> @@ -27,9 +36,15 @@ <ReturnType>System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Windows.Forms.Design.Behavior.BehaviorService.Adorners" /> property provides access to the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> managed by the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</para> + </summary> </Docs> </Member> <Member MemberName="AdornerWindowGraphics"> @@ -42,9 +57,12 @@ <ReturnType>System.Drawing.Graphics</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Drawing.Graphics" /> for the adorner window.</para> + </summary> </Docs> </Member> <Member MemberName="AdornerWindowPointToScreen"> @@ -60,10 +78,14 @@ <Parameter Name="p" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="p">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Translates a <see cref="T:System.Drawing.Point" /> in the adorner window to screen coordinates.</para> + </summary> + <param name="p"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Point" /> value to transform.</param> </Docs> </Member> <Member MemberName="AdornerWindowToScreen"> @@ -77,9 +99,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the location of the adorner window in screen coordinates.</para> + </summary> </Docs> </Member> <Member MemberName="BeginDrag"> @@ -92,8 +117,15 @@ <ReturnType>System.Windows.Forms.Design.Behavior.BehaviorDragDropEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> raises the <see cref="E:System.Windows.Forms.Design.Behavior.BehaviorService.BeginDrag" /> event immediately before it starts a drag-and-drop operation.</para> + <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 the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> starts a drag-and-drop operation.</para> + </summary> </Docs> </Member> <Member MemberName="ControlRectInAdornerWindow"> @@ -109,10 +141,17 @@ <Parameter Name="c" Type="System.Windows.Forms.Control" /> </Parameters> <Docs> - <param name="c">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The adorner window is a transparent window that resides on top of the designer's frame. This window is used by the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> to intercept all messages. It also serves as a unified canvas on which to paint a <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the bounding <see cref="T:System.Drawing.Rectangle" /> of a <see cref="T:System.Windows.Forms.Control" />.</para> + </summary> + <param name="c"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Control" /> to translate.</param> </Docs> </Member> <Member MemberName="ControlToAdornerWindow"> @@ -128,10 +167,14 @@ <Parameter Name="c" Type="System.Windows.Forms.Control" /> </Parameters> <Docs> - <param name="c">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the location of a <see cref="T:System.Windows.Forms.Control" /> translated to adorner window coordinates.</para> + </summary> + <param name="c"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Control" /> to translate.</param> </Docs> </Member> <Member MemberName="CurrentBehavior"> @@ -144,9 +187,12 @@ <ReturnType>System.Windows.Forms.Design.Behavior.Behavior</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> at the top of the behavior stack without removing it.</para> + </summary> </Docs> </Member> <Member MemberName="Dispose"> @@ -160,8 +206,17 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Call <see cref="M:System.Windows.Forms.Design.Behavior.BehaviorService.Dispose" /> when you are finished using the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. The <see cref="M:System.Windows.Forms.Design.Behavior.BehaviorService.Dispose" /> method leaves the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> in an unusable state. After calling <see cref="M:System.Windows.Forms.Design.Behavior.BehaviorService.Dispose" />, you must release all references to the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> so the garbage collector can reclaim the memory that the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> 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.Windows.Forms.Design.Behavior.BehaviorService.Dispose" /> before you release your last reference to the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> 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.Windows.Forms.Design.Behavior.BehaviorService" />. </para> + </summary> </Docs> </Member> <Member MemberName="EndDrag"> @@ -174,8 +229,15 @@ <ReturnType>System.Windows.Forms.Design.Behavior.BehaviorDragDropEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> raises the <see cref="E:System.Windows.Forms.Design.Behavior.BehaviorService.EndDrag" /> event immediately after the drag operation is complete.</para> + <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 the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> completes a drag operation.</para> + </summary> </Docs> </Member> <Member MemberName="GetNextBehavior"> @@ -191,10 +253,14 @@ <Parameter Name="behavior" Type="System.Windows.Forms.Design.Behavior.Behavior" /> </Parameters> <Docs> - <param name="behavior">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> immediately after the given <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> in the behavior stack.</para> + </summary> + <param name="behavior"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> preceding the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> to be returned.</param> </Docs> </Member> <Member MemberName="Invalidate"> @@ -208,8 +274,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Calling the <see cref="Overload:System.Windows.Forms.Design.Behavior.BehaviorService.Invalidate" /> method forces a refresh of all <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> objects and, in turn, all <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Invalidates the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> </Docs> </Member> <Member MemberName="Invalidate"> @@ -225,9 +297,16 @@ <Parameter Name="rect" Type="System.Drawing.Rectangle" /> </Parameters> <Docs> - <param name="rect">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.BehaviorService.Invalidate(System.Drawing.Rectangle)" /> method will force a refresh of all <see cref="P:System.Windows.Forms.Design.Behavior.BehaviorService.Adorners" /> and, in turn, all <see cref="P:System.Windows.Forms.Design.Behavior.Adorner.Glyphs" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Invalidates, within the adorner window, the specified area of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="rect"> + <attribution license="cc4" from="Microsoft" modified="false" />The rectangular area to invalidate.</param> </Docs> </Member> <Member MemberName="Invalidate"> @@ -243,9 +322,16 @@ <Parameter Name="r" Type="System.Drawing.Region" /> </Parameters> <Docs> - <param name="r">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.BehaviorService.Invalidate(System.Drawing.Region)" /> method will force a refresh of all <see cref="P:System.Windows.Forms.Design.Behavior.BehaviorService.Adorners" /> and, in turn, all <see cref="P:System.Windows.Forms.Design.Behavior.Adorner.Glyphs" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Invalidates, within the adorner window, the specified area of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="r"> + <attribution license="cc4" from="Microsoft" modified="false" />The region to invalidate.</param> </Docs> </Member> <Member MemberName="MapAdornerWindowPoint"> @@ -262,11 +348,16 @@ <Parameter Name="pt" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="handle">To be added.</param> - <param name="pt">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts a point in a handle's coordinate system to the adorner window coordinates.</para> + </summary> + <param name="handle"> + <attribution license="cc4" from="Microsoft" modified="false" />An adorner window's handle.</param> + <param name="pt"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Point" /> in a handle's coordinate system.</param> </Docs> </Member> <Member MemberName="PopBehavior"> @@ -282,10 +373,17 @@ <Parameter Name="behavior" Type="System.Windows.Forms.Design.Behavior.Behavior" /> </Parameters> <Docs> - <param name="behavior">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the current <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> from the behavior stack internally maintained by the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes and returns the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> at the top of the stack.</para> + </summary> + <param name="behavior"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> to remove from the stack.</param> </Docs> </Member> <Member MemberName="PushBehavior"> @@ -301,9 +399,16 @@ <Parameter Name="behavior" Type="System.Windows.Forms.Design.Behavior.Behavior" /> </Parameters> <Docs> - <param name="behavior">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.BehaviorService.PushBehavior(System.Windows.Forms.Design.Behavior.Behavior)" /> method is often performed by means of a hit-tested <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Pushes a <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> onto the behavior stack.</para> + </summary> + <param name="behavior"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> to push.</param> </Docs> </Member> <Member MemberName="PushCaptureBehavior"> @@ -319,9 +424,16 @@ <Parameter Name="behavior" Type="System.Windows.Forms.Design.Behavior.Behavior" /> </Parameters> <Docs> - <param name="behavior">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Pushing a capture behavior is often done through a hit-tested <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />. If a behavior calls the <see cref="M:System.Windows.Forms.Design.Behavior.BehaviorService.PushCaptureBehavior(System.Windows.Forms.Design.Behavior.Behavior)" /> method and mouse capture is lost, the behavior's <see cref="M:System.Windows.Forms.Design.Behavior.Behavior.OnLoseCapture(System.Windows.Forms.Design.Behavior.Glyph,System.EventArgs)" /> method is called.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Pushes a <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> onto the behavior stack and assigns mouse capture to the behavior.</para> + </summary> + <param name="behavior"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> to push.</param> </Docs> </Member> <Member MemberName="ScreenToAdornerWindow"> @@ -337,10 +449,14 @@ <Parameter Name="p" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="p">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Translates a point in screen coordinates into the adorner window coordinates of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </summary> + <param name="p"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Point" /> value to transform.</param> </Docs> </Member> <Member MemberName="Synchronize"> @@ -353,8 +469,14 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <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 the current selection should be refreshed.</para> + </summary> </Docs> </Member> <Member MemberName="SyncSelection"> @@ -368,9 +490,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Synchronizes all selection glyphs.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollection.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollection.xml index 9279afcc12d..c4502eede27 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BehaviorServiceAdornerCollection" FullName="System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection"> <TypeSignature Language="C#" Value="public sealed class BehaviorServiceAdornerCollection : System.Collections.CollectionBase" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Stores <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> objects in a strongly typed collection.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +27,13 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Adorner[]" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.BehaviorServiceAdornerCollection" /> class with the given array.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> to populate the collection.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -38,9 +46,13 @@ <Parameter Name="behaviorService" Type="System.Windows.Forms.Design.Behavior.BehaviorService" /> </Parameters> <Docs> - <param name="behaviorService">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.BehaviorServiceAdornerCollection" /> class with the given <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> reference.</para> + </summary> + <param name="behaviorService"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> reference. </param> </Docs> </Member> <Member MemberName=".ctor"> @@ -53,9 +65,13 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.BehaviorServiceAdornerCollection" /> class from an existing <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> from which to populate the collection. </param> </Docs> </Member> <Member MemberName="Add"> @@ -71,10 +87,14 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Adorner" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds an <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> with the specified value to the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> to add to the end of the collection.</param> </Docs> </Member> <Member MemberName="AddRange"> @@ -90,9 +110,13 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Adorner[]" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the elements of an array to the end of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> to copy to the end of the collection</param> </Docs> </Member> <Member MemberName="AddRange"> @@ -108,9 +132,13 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the contents of another <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> to the end of the collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> to add to the end of the collection.</param> </Docs> </Member> <Member MemberName="Contains"> @@ -126,10 +154,14 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Adorner" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> contains the specified <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> to locate.</param> </Docs> </Member> <Member MemberName="CopyTo"> @@ -146,10 +178,15 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> values to a one-dimensional <see cref="T:System.Array" /> at the specified index.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional <see cref="T:System.Array" /> that is the destination of the values copied from <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The index in <paramref name="array" /> where copying begins.</param> </Docs> </Member> <Member MemberName="GetEnumerator"> @@ -163,9 +200,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns an enumerator that can iterate through the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> instance.</para> + </summary> </Docs> </Member> <Member MemberName="IndexOf"> @@ -181,10 +221,14 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Adorner" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the index of an <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> in the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> to locate.</param> </Docs> </Member> <Member MemberName="Insert"> @@ -201,10 +245,15 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Adorner" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts an <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> into the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> at the specified index.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index where <paramref name="value" /> should be inserted.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> to insert.</param> </Docs> </Member> <Member MemberName="Item"> @@ -239,10 +288,14 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Adorner" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes a specific <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> from the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> to remove from the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollectionEnumerator.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollectionEnumerator.xml index 9aad14216d8..f20dcea85cb 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollectionEnumerator.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollectionEnumerator.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BehaviorServiceAdornerCollectionEnumerator" FullName="System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollectionEnumerator"> <TypeSignature Language="C#" Value="public class BehaviorServiceAdornerCollectionEnumerator : System.Collections.IEnumerator" /> <AssemblyInfo> @@ -13,8 +14,11 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Supports iteration over a <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,9 +31,13 @@ <Parameter Name="mappings" Type="System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> </Parameters> <Docs> - <param name="mappings">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.BehaviorServiceAdornerCollectionEnumerator" /> class. </para> + </summary> + <param name="mappings"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> for which to create the enumerator. </param> </Docs> </Member> <Member MemberName="Current"> @@ -42,9 +50,12 @@ <ReturnType>System.Windows.Forms.Design.Behavior.Adorner</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the current element in the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</para> + </summary> </Docs> </Member> <Member MemberName="MoveNext"> @@ -58,9 +69,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Advances the enumerator to the next element of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</para> + </summary> </Docs> </Member> <Member MemberName="Reset"> @@ -74,8 +88,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the enumerator to its initial position, which is before the first element in the collection.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IEnumerator.Current"> @@ -88,9 +105,15 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollectionEnumerator" /> instance is cast to an <see cref="T:System.Collections.IEnumerator" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="P:System.Collections.IEnumerator.Current" /> property.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IEnumerator.MoveNext"> @@ -104,9 +127,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollectionEnumerator" /> instance is cast to an <see cref="T:System.Collections.IEnumerator" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.Collections.IEnumerator.MoveNext" /> method.</para> + </summary> </Docs> </Member> <Member MemberName="System.Collections.IEnumerator.Reset"> @@ -120,9 +149,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollectionEnumerator" /> instance is cast to an <see cref="T:System.Collections.IEnumerator" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see the <see cref="M:System.Collections.IEnumerator.Reset" /> method.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/ComponentGlyph.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/ComponentGlyph.xml index 2d5c76c25cc..b3c0a53807f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/ComponentGlyph.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/ComponentGlyph.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ComponentGlyph" FullName="System.Windows.Forms.Design.Behavior.ComponentGlyph"> <TypeSignature Language="C#" Value="public class ComponentGlyph : System.Windows.Forms.Design.Behavior.Glyph" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.ComponentGlyph" /> class contains the <see cref="P:System.Windows.Forms.Design.Behavior.ComponentGlyph.RelatedComponent" /> property, which points back to the glyph's related component. This property can be used to trace <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects back to their component, such as during drag operations.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Associates a <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> with its component.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +30,13 @@ <Parameter Name="relatedComponent" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="relatedComponent">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.ComponentGlyph" /> class.</para> + </summary> + <param name="relatedComponent"> + <attribution license="cc4" from="Microsoft" modified="false" />The component with which the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is associated.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -39,10 +50,15 @@ <Parameter Name="behavior" Type="System.Windows.Forms.Design.Behavior.Behavior" /> </Parameters> <Docs> - <param name="relatedComponent">To be added.</param> - <param name="behavior">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.ComponentGlyph" /> class. </para> + </summary> + <param name="relatedComponent"> + <attribution license="cc4" from="Microsoft" modified="false" />The component with which the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is associated.</param> + <param name="behavior"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> with which the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is associated.</param> </Docs> </Member> <Member MemberName="GetHitTest"> @@ -58,10 +74,17 @@ <Parameter Name="p" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="p">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation does nothing and returns null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether a mouse click at the specified point should be handled by the <see cref="T:System.Windows.Forms.Design.Behavior.ComponentGlyph" />.</para> + </summary> + <param name="p"> + <attribution license="cc4" from="Microsoft" modified="false" />A point to hit-test.</param> </Docs> </Member> <Member MemberName="Paint"> @@ -77,9 +100,16 @@ <Parameter Name="pe" Type="System.Windows.Forms.PaintEventArgs" /> </Parameters> <Docs> - <param name="pe">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation does nothing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides paint logic.</para> + </summary> + <param name="pe"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.PaintEventArgs" /> containing the <see cref="P:System.Windows.Forms.Design.Behavior.BehaviorService.AdornerWindowGraphics" /> of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</param> </Docs> </Member> <Member MemberName="RelatedComponent"> @@ -92,10 +122,13 @@ <ReturnType>System.ComponentModel.IComponent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the component that is associated with the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> .</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/ControlBodyGlyph.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/ControlBodyGlyph.xml index e0958089845..2a39c07c08d 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/ControlBodyGlyph.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/ControlBodyGlyph.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ControlBodyGlyph" FullName="System.Windows.Forms.Design.Behavior.ControlBodyGlyph"> <TypeSignature Language="C#" Value="public class ControlBodyGlyph : System.Windows.Forms.Design.Behavior.ComponentGlyph" /> <AssemblyInfo> @@ -9,8 +10,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is placed on every control and is sized to the exact bounds of each control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Associates a <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> with its control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -26,12 +33,19 @@ <Parameter Name="behavior" Type="System.Windows.Forms.Design.Behavior.Behavior" /> </Parameters> <Docs> - <param name="bounds">To be added.</param> - <param name="cursor">To be added.</param> - <param name="relatedComponent">To be added.</param> - <param name="behavior">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.ControlBodyGlyph" /> class.</para> + </summary> + <param name="bounds"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Rectangle" /> that represents the bounds of the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</param> + <param name="cursor"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Cursor" /> that represents the cursor to display when the mouse pointer is over the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</param> + <param name="relatedComponent"> + <attribution license="cc4" from="Microsoft" modified="false" />The component with which the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is associated.</param> + <param name="behavior"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> with which the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is associated.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -47,12 +61,19 @@ <Parameter Name="designer" Type="System.Windows.Forms.Design.ControlDesigner" /> </Parameters> <Docs> - <param name="bounds">To be added.</param> - <param name="cursor">To be added.</param> - <param name="relatedComponent">To be added.</param> - <param name="designer">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.ControlBodyGlyph" /> class.</para> + </summary> + <param name="bounds"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Rectangle" /> that represents the bounds of the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</param> + <param name="cursor"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Cursor" /> that represents the cursor to display when the mouse pointer is over the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</param> + <param name="relatedComponent"> + <attribution license="cc4" from="Microsoft" modified="false" />The component with which the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is associated.</param> + <param name="designer"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> with which the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is associated.</param> </Docs> </Member> <Member MemberName="Bounds"> @@ -65,9 +86,12 @@ <ReturnType>System.Drawing.Rectangle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the bounds of the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </summary> </Docs> </Member> <Member MemberName="GetHitTest"> @@ -83,11 +107,15 @@ <Parameter Name="p" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="p">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether a mouse click at the specified point should be handled by the <see cref="T:System.Windows.Forms.Design.Behavior.ControlBodyGlyph" />.</para> + </summary> + <param name="p"> + <attribution license="cc4" from="Microsoft" modified="false" />A point to hit test.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Glyph.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Glyph.xml index 66ed2bca52f..5d374738ecf 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Glyph.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/Glyph.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="Glyph" FullName="System.Windows.Forms.Design.Behavior.Glyph"> <TypeSignature Language="C#" Value="public abstract class Glyph" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The sole purpose of a <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is to paint and hit test. A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> does not have a window handle (HWND), as it is rendered on the adorner window control of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. Each <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> can have a <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> associated with it. A successfully hit-tested <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> has the opportunity to push a new or different <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> onto the behavior stack of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />. </para> + <para>For more information, see <format type="text/html"><a href="7c60cc41-4324-46b5-b444-b39eda7cb33f">Behavior Service Overview</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a single user interface (UI) entity managed by an <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" />.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,9 +31,13 @@ <Parameter Name="behavior" Type="System.Windows.Forms.Design.Behavior.Behavior" /> </Parameters> <Docs> - <param name="behavior">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.Glyph" /> class. </para> + </summary> + <param name="behavior"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> associated with the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />. Can be null.</param> </Docs> </Member> <Member MemberName="Behavior"> @@ -38,9 +50,12 @@ <ReturnType>System.Windows.Forms.Design.Behavior.Behavior</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> associated with the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </summary> </Docs> </Member> <Member MemberName="Bounds"> @@ -53,9 +68,12 @@ <ReturnType>System.Drawing.Rectangle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the bounds of the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </summary> </Docs> </Member> <Member MemberName="GetHitTest"> @@ -71,10 +89,17 @@ <Parameter Name="p" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="p">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Glyph.GetHitTest(System.Drawing.Point)" /> method is an abstract method that forces <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> implementations to provide hit test logic. Given any point, if the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> has decided to be involved with that location, it will need to return a valid <see cref="T:System.Windows.Forms.Cursor" />. Otherwise, returning null will cause the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> to ignore the location.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides hit test logic.</para> + </summary> + <param name="p"> + <attribution license="cc4" from="Microsoft" modified="false" />A point to hit-test.</param> </Docs> </Member> <Member MemberName="Paint"> @@ -90,9 +115,16 @@ <Parameter Name="pe" Type="System.Windows.Forms.PaintEventArgs" /> </Parameters> <Docs> - <param name="pe">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.Behavior.Glyph.Paint(System.Windows.Forms.PaintEventArgs)" /> method is an abstract method that forces <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> implementations to provide paint logic. The <paramref name="pe" /> parameter contains the <see cref="T:System.Drawing.Graphics" /> related to the adorner window of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides paint logic.</para> + </summary> + <param name="pe"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.PaintEventArgs" /> that contains the event data. </param> </Docs> </Member> <Member MemberName="SetBehavior"> @@ -108,10 +140,14 @@ <Parameter Name="behavior" Type="System.Windows.Forms.Design.Behavior.Behavior" /> </Parameters> <Docs> - <param name="behavior">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Changes the <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> associated with the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </summary> + <param name="behavior"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Behavior" /> to associate with the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/GlyphCollection.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/GlyphCollection.xml index 1db38fbeb58..fb4251a0407 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/GlyphCollection.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/GlyphCollection.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="GlyphCollection" FullName="System.Windows.Forms.Design.Behavior.GlyphCollection"> <TypeSignature Language="C#" Value="public class GlyphCollection : System.Collections.CollectionBase" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Stores <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects in a strongly typed collection.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.Behavior.GlyphCollection" /> class.</para> + </summary> </Docs> </Member> <Member MemberName=".ctor"> @@ -35,9 +42,13 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Glyph[]" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.GlyphCollection" /> class with the given <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> array.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> to populate the collection.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -50,9 +61,13 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.GlyphCollection" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <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.Design.Behavior.GlyphCollection" /> class based on another <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" /> to populate the collection.</param> </Docs> </Member> <Member MemberName="Add"> @@ -68,10 +83,14 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Glyph" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> with the specified value to the <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> to add to the end of the collection.</param> </Docs> </Member> <Member MemberName="AddRange"> @@ -87,9 +106,13 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Glyph[]" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the elements of an array to the end of the <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> to copy to the end of the collection.</param> </Docs> </Member> <Member MemberName="AddRange"> @@ -105,9 +128,13 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.GlyphCollection" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds the contents of another <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" /> to the end of the collection.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" /> to add to the end of the collection.</param> </Docs> </Member> <Member MemberName="Contains"> @@ -123,10 +150,14 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Glyph" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" /> contains the specified <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> to locate.</param> </Docs> </Member> <Member MemberName="CopyTo"> @@ -143,10 +174,15 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="array">To be added.</param> - <param name="index">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" /> values to a one-dimensional <see cref="T:System.Array" /> at the specified index.</para> + </summary> + <param name="array"> + <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional <see cref="T:System.Array" /> that is the destination of the values copied from <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" />.</param> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The index in <paramref name="array" /> where copying begins. </param> </Docs> </Member> <Member MemberName="IndexOf"> @@ -162,10 +198,14 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Glyph" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the index of a <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> in the <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> to locate.</param> </Docs> </Member> <Member MemberName="Insert"> @@ -182,10 +222,15 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Glyph" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Inserts a <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> into the <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" /> at the specified index.</para> + </summary> + <param name="index"> + <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index where <paramref name="value" /> should be inserted. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> to insert.</param> </Docs> </Member> <Member MemberName="Item"> @@ -220,10 +265,14 @@ <Parameter Name="value" Type="System.Windows.Forms.Design.Behavior.Glyph" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes a specific <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> from the <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" />.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> to remove from the <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" />.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/GlyphSelectionType.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/GlyphSelectionType.xml index 17f09ca7a3a..cd1fd1cac06 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/GlyphSelectionType.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/GlyphSelectionType.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="GlyphSelectionType" FullName="System.Windows.Forms.Design.Behavior.GlyphSelectionType"> <TypeSignature Language="C#" Value="public enum GlyphSelectionType" /> <AssemblyInfo> @@ -8,8 +9,11 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Describes the designer selection state of a <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </summary> </Docs> <Members> <Member MemberName="NotSelected"> @@ -22,7 +26,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.GlyphSelectionType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is not selected.</para> + </summary> </Docs> </Member> <Member MemberName="Selected"> @@ -35,7 +42,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.GlyphSelectionType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is selected.</para> + </summary> </Docs> </Member> <Member MemberName="SelectedPrimary"> @@ -48,8 +58,11 @@ <ReturnType>System.Windows.Forms.Design.Behavior.GlyphSelectionType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> is the primary selection. </para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLine.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLine.xml index 1c125b62b69..219c2357ac1 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLine.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLine.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="SnapLine" FullName="System.Windows.Forms.Design.Behavior.SnapLine"> <TypeSignature Language="C#" Value="public sealed class SnapLine" /> <AssemblyInfo> @@ -9,8 +10,119 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The following table lists the common modes that visual design tools support to assist you with positioning and sizing controls on a design surface.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Mode</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para>Freeform</para> + </term> + <description> + <para>Enables you to freely lay out controls.</para> + </description> + </item> + <item> + <term> + <para>Grid</para> + </term> + <description> + <para>Displays a static overlaid grid that assists you in laying out controls.</para> + </description> + </item> + <item> + <term> + <para>Snapline</para> + </term> + <description> + <para>Displays guide lines that assist you in laying out the container's controls relative to each other. Snaplines originate from controls and their container.</para> + </description> + </item> + </list> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> class and related types help support the Snapline mode. </para> + <para>Snaplines are generated dynamically and automatically as a control edge moves near another control or near the boundaries of its container. This can occur when a control is added from the toolbox, or moved or resized by mouse operations or keyboard commands. Controls typically have both horizontal and vertical snaplines defined; for rectangular controls, these typically extend from all four edges. </para> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> class uses only a few properties to describe each snapline, as shown in the following table.</para> + <list type="table"> + <listheader> + <item> + <term> + <para>Property</para> + </term> + <description> + <para>Description</para> + </description> + </item> + </listheader> + <item> + <term> + <para> + <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.SnapLineType" /> + </para> + </term> + <description> + <para>Specifies the location and direction of the line with respect to its associated control. Typically, only snaplines of similar types will auto-align to each other.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Offset" /> </para> + </term> + <description> + <para>Specifies the distance in pixels from the origin, which is the upper-left corner of the control, to where the snapline starts.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Priority" /> </para> + </term> + <description> + <para>Specifies the relative importance of the snapline. During any given layout decision point, only the snaplines that are active and have the highest priority are displayed. </para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Filter" /> </para> + </term> + <description> + <para>Defines custom categories of snaplines. This is an optional string.</para> + </description> + </item> + <item> + <term> + <para> + <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.IsHorizontal" /> and <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.IsVertical" /> </para> + </term> + <description> + <para>Indicates whether a snapline has horizontal or vertical orientation, respectively.</para> + </description> + </item> + </list> + <para>The <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> class stores snaplines for its corresponding control type in the <see cref="P:System.Windows.Forms.Design.ControlDesigner.SnapLines" /> property. This base class handling of snaplines will suffice for the majority of controls, as it defines the <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Left" />, <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Right" />, <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Top" />, and <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Bottom" /> snaplines, which are aligned along the edges of the control. When you are developing a custom control, if this default organization does not suffice, override the <see cref="P:System.Windows.Forms.Design.ControlDesigner.SnapLines" /> property of the class derived from <see cref="T:System.Windows.Forms.Design.ControlDesigner" />. For example, you may want to align the horizontal snaplines of text-based controls, such as labels, with the top and base lines of the text (instead of the top and bottom edges of the control).</para> + <para>The <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.SnapLineType" /> class cannot be derived from.</para> + <para>There is extensive support for this feature in Visual Studio.</para> + <para> + <dynamicLink> + <keyword>dl_WalkthroughArrangingControlsWindowsFormsUsingSnaplines</keyword> + </dynamicLink> + </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the horizontal and vertical line segments that are dynamically created in the user interface (UI) to assist in the design-time layout of controls in a container. This class cannot be inherited.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,10 +136,18 @@ <Parameter Name="offset" Type="System.Int32" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <param name="offset">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor sets the <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Filter" /> property to null and the <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Priority" /> property to <see cref="F:System.Windows.Forms.Design.Behavior.SnapLinePriority.Low" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> class using the specified snapline type and offset.</para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLineType" /> to create. Describes the relative position and orientation of the snapline.</param> + <param name="offset"> + <attribution license="cc4" from="Microsoft" modified="false" />The position of the snapline, in pixels, relative to the upper-left origin of the owning control.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -42,11 +162,20 @@ <Parameter Name="filter" Type="System.String" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <param name="offset">To be added.</param> - <param name="filter">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor sets the <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Priority" /> property to <see cref="F:System.Windows.Forms.Design.Behavior.SnapLinePriority.Low" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> class using the specified snapline type, offset, and filter name. </para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLineType" /> to create. Describes the relative position and orientation of the snapline.</param> + <param name="offset"> + <attribution license="cc4" from="Microsoft" modified="false" />The position of the snapline, in pixels, relative to the upper-left origin of the owning control.</param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> used to specify a programmer-defined category of snaplines.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -61,11 +190,20 @@ <Parameter Name="priority" Type="System.Windows.Forms.Design.Behavior.SnapLinePriority" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <param name="offset">To be added.</param> - <param name="priority">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor sets the <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Filter" /> property to null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> class using the specified snapline type, offset, and priority. </para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLineType" /> to create. Describes the relative position and orientation of the snapline.</param> + <param name="offset"> + <attribution license="cc4" from="Microsoft" modified="false" />The position of the snapline, in pixels, relative to the upper-left origin of the owning control.</param> + <param name="priority"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLinePriority" /> of the snapline.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -81,12 +219,22 @@ <Parameter Name="priority" Type="System.Windows.Forms.Design.Behavior.SnapLinePriority" /> </Parameters> <Docs> - <param name="type">To be added.</param> - <param name="offset">To be added.</param> - <param name="filter">To be added.</param> - <param name="priority">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor sets all of the properties of a snapline to programmer-supplied values.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> class using the specified snapline type, offset, filter name, and priority. </para> + </summary> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLineType" /> to create. Describes the relative position and orientation of the snapline.</param> + <param name="offset"> + <attribution license="cc4" from="Microsoft" modified="false" />The position of the snapline, in pixels, relative to the upper-left origin of the owning control.</param> + <param name="filter"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> used to specify a programmer-defined category of snaplines.</param> + <param name="priority"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLinePriority" /> of the snapline.</param> </Docs> </Member> <Member MemberName="AdjustOffset"> @@ -102,9 +250,16 @@ <Parameter Name="adjustment" Type="System.Int32" /> </Parameters> <Docs> - <param name="adjustment">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The offset of a snapline is the distance, in pixels, that the snapline is located from the associated control's upper-left origin. Although the offset can be set to any integer value, typically the snaplines retain the spatial relationships implied by their <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.SnapLineType" /> property value.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adjusts the <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Offset" /> property of the snapline.</para> + </summary> + <param name="adjustment"> + <attribution license="cc4" from="Microsoft" modified="false" />The number of pixels to change the snapline offset by.</param> </Docs> </Member> <Member MemberName="Filter"> @@ -117,9 +272,16 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Filter" /> property is used to define custom categories of snaplines. Only snaplines with the same filter name are able to snap to each other. This property can be used in custom control designers to expose different categories of snaplines depending upon the state of the control or the type of operation being performed. For example, round controls could offer a custom snapline with the filter value of "Center".</para> + <para>This property is initialized during construction and cannot be changed thereafter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the programmer-defined filter category associated with this snapline.</para> + </summary> </Docs> </Member> <Member MemberName="IsHorizontal"> @@ -132,9 +294,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The following snapline types are horizontal: <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Top" />, <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Bottom" />, <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Horizontal" />, and <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Baseline" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the snapline has a horizontal orientation.</para> + </summary> </Docs> </Member> <Member MemberName="IsVertical"> @@ -147,9 +315,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The following snapline types are vertical: <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Left" />, <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Right" />, and <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Vertical" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the snapline has a vertical orientation.</para> + </summary> </Docs> </Member> <Member MemberName="Offset"> @@ -162,9 +336,16 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The origin of a control is the upper-left point of the control. A single offset can describe the position of a snapline, because vertical snaplines may have only a nonzero x-axis offset, whereas horizontal snaplines may only have a nonzero y-axis offset.</para> + <para>The <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Offset" /> property is initialized at construction time, but it can be changed thereafter with the <see cref="M:System.Windows.Forms.Design.Behavior.SnapLine.AdjustOffset(System.Int32)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of pixels that the snapline is offset from the origin of the associated control.</para> + </summary> </Docs> </Member> <Member MemberName="Priority"> @@ -177,9 +358,17 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLinePriority</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.Priority" /> property establishes categories of importance for the snaplines associated with a control. </para> + <para>The Windows Forms Designer uses this property to determine which snaplines to display during a control addition, resize, or move operation. For more information, see the <see cref="T:System.Windows.Forms.Design.Behavior.SnapLinePriority" /> enumeration.</para> + <para>This property is initialized during construction and cannot be changed thereafter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating the relative importance of the snapline.</para> + </summary> </Docs> </Member> <Member MemberName="ShouldSnap"> @@ -196,11 +385,16 @@ <Parameter Name="line2" Type="System.Windows.Forms.Design.Behavior.SnapLine" /> </Parameters> <Docs> - <param name="line1">To be added.</param> - <param name="line2">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value indicating whether the specified <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> should snap to another <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" />.</para> + </summary> + <param name="line1"> + <attribution license="cc4" from="Microsoft" modified="false" />The specified <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" />.</param> + <param name="line2"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> to which the specified <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> is expected to snap.</param> </Docs> </Member> <Member MemberName="SnapLineType"> @@ -213,9 +407,16 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLineType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Visual designers use the <see cref="P:System.Windows.Forms.Design.Behavior.SnapLine.SnapLineType" /> property to direct snap alignment operations. Typically only snaplines that are similarly oriented can snap to each other. For example, two snaplines of type <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Horizontal" /> can snap together, but a <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Horizontal" /> and a <see cref="F:System.Windows.Forms.Design.Behavior.SnapLineType.Vertical" /> snapline cannot.</para> + <para>This property is initialized during construction and cannot be changed thereafter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type of a snapline, which indicates the general location and orientation.</para> + </summary> </Docs> </Member> <Member MemberName="ToString"> @@ -229,10 +430,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method returns a string that contains details about the type, offset, priority, and filter values of the snapline.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a string representation of the current snapline.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLinePriority.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLinePriority.xml index 9a242d3faab..cef4e6408b1 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLinePriority.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLinePriority.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="SnapLinePriority" FullName="System.Windows.Forms.Design.Behavior.SnapLinePriority"> <TypeSignature Language="C#" Value="public enum SnapLinePriority" /> <AssemblyInfo> @@ -8,8 +9,15 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A snapline's priority acts as a suggestion to visual designers about how to treat a snapline with respect to its peers. The layout engine uses a simple method of determining whether to display the snaplines for a control: only the highest priority snaplines, including those with a value of <see cref="F:System.Windows.Forms.Design.Behavior.SnapLinePriority.Always" />, are shown for each orientation—vertical or horizontal.</para> + <para>To set the priority of a snapline, a <see cref="T:System.Windows.Forms.Design.Behavior.SnapLinePriority" /> enumeration is specified when creating an instance of the <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the relative importance of a snapline.</para> + </summary> </Docs> <Members> <Member MemberName="Always"> @@ -22,7 +30,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLinePriority</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The priority category that is equivalent to the highest priority of all the current snaplines. Indicates that this category of snapline should always be active.</para> + </summary> </Docs> </Member> <Member MemberName="High"> @@ -35,7 +46,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLinePriority</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The highest priority category.</para> + </summary> </Docs> </Member> <Member MemberName="Low"> @@ -48,7 +62,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLinePriority</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The lowest priority category.</para> + </summary> </Docs> </Member> <Member MemberName="Medium"> @@ -61,8 +78,11 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLinePriority</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The middle priority category.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLineType.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLineType.xml index 72cf0fce901..253b9586325 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLineType.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design.Behavior/SnapLineType.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="SnapLineType" FullName="System.Windows.Forms.Design.Behavior.SnapLineType"> <TypeSignature Language="C#" Value="public enum SnapLineType" /> <AssemblyInfo> @@ -8,8 +9,14 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.Behavior.SnapLineType" /> enumeration can be specified when creating an instance of the <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the orientation and relative location of a snapline.</para> + </summary> </Docs> <Members> <Member MemberName="Baseline"> @@ -22,7 +29,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLineType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A horizontal snapline typically associated with a primary internal feature of a control; for example, the base of the text string in a <see cref="T:System.Windows.Forms.Label" /> control.</para> + </summary> </Docs> </Member> <Member MemberName="Bottom"> @@ -35,7 +45,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLineType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A horizontal snapline typically aligned to the bottom edge of a control.</para> + </summary> </Docs> </Member> <Member MemberName="Horizontal"> @@ -48,7 +61,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLineType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A horizontal snapline typically not associated with an edge of a control.</para> + </summary> </Docs> </Member> <Member MemberName="Left"> @@ -61,7 +77,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLineType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A vertical snapline typically aligned to the left edge of a control.</para> + </summary> </Docs> </Member> <Member MemberName="Right"> @@ -74,7 +93,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLineType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A vertical snapline typically aligned to the right edge of a control.</para> + </summary> </Docs> </Member> <Member MemberName="Top"> @@ -87,7 +109,10 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLineType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A horizontal snapline typically aligned to the top edge of a control.</para> + </summary> </Docs> </Member> <Member MemberName="Vertical"> @@ -100,8 +125,11 @@ <ReturnType>System.Windows.Forms.Design.Behavior.SnapLineType</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A vertical snapline typically not associated with an edge of a control.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AnchorEditor.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AnchorEditor.xml index bd18e39ff29..97da8380bbd 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AnchorEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AnchorEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="AnchorEditor" FullName="System.Windows.Forms.Design.AnchorEditor"> <TypeSignature Language="C#" Value="public sealed class AnchorEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.AnchorEditor" /> provides a design-time user interface for configuring an <see cref="P:System.Windows.Forms.Control.Anchor" /> property. An <see cref="P:System.Windows.Forms.Control.Anchor" /> property is typically used to determine which sides of the container a control is bound to. This class provides a drop-down graphical control that allows the user to specify which sides of the container to anchor the control to.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for configuring an <see cref="P:System.Windows.Forms.Control.Anchor" /> property.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.AnchorEditor" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,12 +49,21 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A service provider is provided so that any required editing services can be obtained.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the value of the specified object using the specified service provider and context.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> through which editing services may be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the value being edited. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,10 +80,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editor style used by the <see cref="M:System.Windows.Forms.Design.AnchorEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -72,4 +95,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxImporter.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxImporter.xml index 33f4966f8b2..d20488494ee 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxImporter.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxImporter.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="AxImporter" FullName="System.Windows.Forms.Design.AxImporter"> <TypeSignature Language="C#" Value="public class AxImporter" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>To generate an ActiveX wrapper for an ActiveX control, first create or obtain an instance of the <see cref="T:System.Windows.Forms.Design.AxImporter" /> class. The <see cref="T:System.Windows.Forms.Design.AxImporter" /> constructor accepts an <see cref="T:System.Windows.Forms.Design.AxImporter.Options" /> object, which sets options for the importer, such as the filename for the wrapper .dll to generate and the output directory to generate the wrapper to. To generate the ActiveX wrapper, call the appropriate Generate method. To generate from a file, call <see cref="M:System.Windows.Forms.Design.AxImporter.GenerateFromFile(System.IO.FileInfo)" />. To generate from a type library, call <see cref="M:System.Windows.Forms.Design.AxImporter.GenerateFromTypeLibrary(System.Runtime.InteropServices.UCOMITypeLib)" />. The string that is returned will consist of an assembly qualified name (example: "Namespace.Type,Assembly") for the type an ActiveX wrapper was generated for. The wrapper for the ActiveX control will be generated in the .dll file specified in the <see cref="F:System.Windows.Forms.Design.AxImporter.Options.outputName" /> property of the <see cref="T:System.Windows.Forms.Design.AxImporter.Options" /> passed to the <see cref="T:System.Windows.Forms.Design.AxImporter" /> constructor. The type can be loaded or queried using <see cref="N:System.Reflection" /> and treated as an ordinary managed type. You can also call the GetOcx method of the type to retrieve a COM interface to the object, if the object supports this.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Imports ActiveX controls and generates a wrapper that can be accessed by a designer.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -37,9 +44,12 @@ <ReturnType>System.String[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the names of the assemblies that are generated for the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -53,9 +63,12 @@ <ReturnType>System.String[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the names of the source files that were generated.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -69,9 +82,12 @@ <ReturnType>System.Runtime.InteropServices.TYPELIBATTR[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the attributes for the generated type library.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -88,10 +104,14 @@ <Parameter Name="file" Type="System.IO.FileInfo" /> </Parameters> <Docs> - <param name="file">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a wrapper for an ActiveX control for use in the design-time environment.</para> + </summary> + <param name="file"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.IO.FileInfo" /> indicating the file that contains the control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -108,10 +128,14 @@ <Parameter Name="typeLib" Type="System.Runtime.InteropServices.UCOMITypeLib" /> </Parameters> <Docs> - <param name="typeLib">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a wrapper for an ActiveX control for use in the design-time environment.</para> + </summary> + <param name="typeLib"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Runtime.InteropServices.UCOMITypeLib" /> that indicates the type library to generate the control from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -129,11 +153,16 @@ <Parameter Name="clsid" Type="System.Guid" /> </Parameters> <Docs> - <param name="typeLib">To be added.</param> - <param name="clsid">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a wrapper for an ActiveX control for use in the design-time environment.</para> + </summary> + <param name="typeLib"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Runtime.InteropServices.UCOMITypeLib" /> that indicates the type library to generate the control from. </param> + <param name="clsid"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Guid" /> for the control wrapper. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -161,4 +190,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxParameterData.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxParameterData.xml index 80b0acb6f1e..a99223a341f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxParameterData.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxParameterData.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="AxParameterData" FullName="System.Windows.Forms.Design.AxParameterData"> <TypeSignature Language="C#" Value="public class AxParameterData" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents a parameter of a method of a hosted ActiveX control.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,9 +25,13 @@ <Parameter Name="info" Type="System.Reflection.ParameterInfo" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <summary>To be added.</summary> <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.Design.AxParameterData" /> class using the specified parameter information.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Reflection.ParameterInfo" /> indicating the parameter information to use. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,10 +46,15 @@ <Parameter Name="ignoreByRefs" Type="System.Boolean" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="ignoreByRefs">To be added.</param> - <summary>To be added.</summary> <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.Design.AxParameterData" /> class using the specified parameter information and whether to ignore by reference parameters.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Reflection.ParameterInfo" /> indicating the parameter information to use. </param> + <param name="ignoreByRefs"> + <attribution license="cc4" from="Microsoft" modified="false" />A value indicating whether to ignore parameters passed by reference. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -56,10 +69,15 @@ <Parameter Name="typeName" Type="System.String" /> </Parameters> <Docs> - <param name="inname">To be added.</param> - <param name="typeName">To be added.</param> - <summary>To be added.</summary> <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.Design.AxParameterData" /> class using the specified name and type name.</para> + </summary> + <param name="inname"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the parameter. </param> + <param name="typeName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the type of the parameter. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -74,10 +92,15 @@ <Parameter Name="type" Type="System.Type" /> </Parameters> <Docs> - <param name="inname">To be added.</param> - <param name="type">To be added.</param> - <summary>To be added.</summary> <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.Design.AxParameterData" /> class using the specified name and type.</para> + </summary> + <param name="inname"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the parameter. </param> + <param name="type"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the parameter. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -94,10 +117,14 @@ <Parameter Name="infos" Type="System.Reflection.ParameterInfo[]" /> </Parameters> <Docs> - <param name="infos">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the specified parameter information to an <see cref="T:System.Windows.Forms.Design.AxParameterData" /> object.</para> + </summary> + <param name="infos"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of <see cref="T:System.Reflection.ParameterInfo" /> objects to convert. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -115,11 +142,16 @@ <Parameter Name="ignoreByRefs" Type="System.Boolean" /> </Parameters> <Docs> - <param name="infos">To be added.</param> - <param name="ignoreByRefs">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Converts the specified parameter information to an <see cref="T:System.Windows.Forms.Design.AxParameterData" /> object, according to the specified value indicating whether to ignore by reference parameters.</para> + </summary> + <param name="infos"> + <attribution license="cc4" from="Microsoft" modified="false" />An array of <see cref="T:System.Reflection.ParameterInfo" /> objects to convert. </param> + <param name="ignoreByRefs"> + <attribution license="cc4" from="Microsoft" modified="false" />A value indicating whether to ignore parameters passed by reference. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -133,9 +165,12 @@ <ReturnType>System.CodeDom.FieldDirection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates the direction of assignment fields.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -149,9 +184,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the parameter data is passed by reference.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -165,9 +203,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the parameter data is in.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -181,9 +222,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the parameter data is optional.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -197,9 +241,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the parameter data is out.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -213,9 +260,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the name of the parameter.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -229,9 +279,12 @@ <ReturnType>System.Type</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type expected by the parameter.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -245,9 +298,12 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the type expected by the parameter.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -255,4 +311,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxWrapperGen.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxWrapperGen.xml index cad21eb9521..ecd7b9e8a5f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxWrapperGen.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/AxWrapperGen.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="AxWrapperGen" FullName="System.Windows.Forms.Design.AxWrapperGen"> <TypeSignature Language="C#" Value="public class AxWrapperGen" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates a wrapper for ActiveX controls for use in the design-time environment.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,9 +25,13 @@ <Parameter Name="axType" Type="System.Type" /> </Parameters> <Docs> - <param name="axType">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Generates an ActiveX wrapper for design-time hosting of an ActiveX control.</para> + </summary> + <param name="axType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of ActiveX control to generate a wrapper for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,8 +45,15 @@ <ReturnType>System.Collections.ArrayList</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This object contains the paths to each of any sources for ActiveX control wrappers that were generated.</para> + <para> </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This field initializes a local <see cref="T:System.Collections.ArrayList" /> variable named GeneratedSources.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -46,4 +61,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/BorderSidesEditor.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/BorderSidesEditor.xml index 96884081273..e170479883f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/BorderSidesEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/BorderSidesEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BorderSidesEditor" FullName="System.Windows.Forms.Design.BorderSidesEditor"> <TypeSignature Language="C#" Value="public class BorderSidesEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an editor for setting the <see cref="P:System.Windows.Forms.ToolStripStatusLabel.BorderSides" /> property.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.BorderSidesEditor" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="EditValue"> @@ -40,12 +47,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the given object value using the editor style provided by <see cref="M:System.Windows.Forms.Design.BorderSidesEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" />.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> providing information about the control or component.</param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> providing custom support to other objects.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object value to edit.</param> </Docs> </Member> <Member MemberName="GetEditStyle"> @@ -61,11 +74,15 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the editing style of the EditValue method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> providing information about the control or component.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ComponentDocumentDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ComponentDocumentDesigner.xml index 0178f7dc151..1c72b271363 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ComponentDocumentDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ComponentDocumentDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ComponentDocumentDesigner" FullName="System.Windows.Forms.Design.ComponentDocumentDesigner"> <TypeSignature Language="C#" Value="public class ComponentDocumentDesigner : System.ComponentModel.Design.ComponentDesigner, System.ComponentModel.Design.IRootDesigner, System.ComponentModel.Design.ITypeDescriptorFilterService, System.Drawing.Design.IToolboxUser, System.Windows.Forms.Design.IOleDragClient" /> <AssemblyInfo> @@ -23,8 +24,19 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> provides a base class for designers of root design documents that support nested components. In addition to the methods and functionality inherited from the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class, <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> implements the <see cref="T:System.ComponentModel.Design.IRootDesigner" /> interface to provide a root-level design mode view for the associated component, and any nested components.</para> + <block subset="none" type="note"> + <para>The root-level design mode view for a <see cref="T:System.Windows.Forms.Form" /> or <see cref="T:System.Windows.Forms.Control" /> is typically provided by a built-in root designer. A custom <see cref="T:System.ComponentModel.Design.IRootDesigner" /> implementation is required to provide a view for other types of root components in design mode.</para> + </block> + <para>You can associate a designer with a type using a <see cref="T:System.ComponentModel.DesignerAttribute" />. For an overview of customizing design time behavior, see <format type="text/html"><a href="d6ac8a6a-42fd-4bc8-bf33-b212811297e2">Extending Design-Time Support</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Base designer class for extending the design mode behavior of a root design document that supports nested components.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -32,8 +44,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.ComponentDocumentDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -47,9 +62,12 @@ <ReturnType>System.Windows.Forms.Control</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the control for the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -66,9 +84,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -85,10 +111,17 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If a tool is supported, it will be enabled in the toolbox when the designer regains focus. Otherwise, it will be disabled. Once a tool is marked as enabled or disabled it cannot be queried again.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the specified tool is supported by the designer.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to test for toolbox support. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -105,9 +138,13 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer with the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to associate with the designer. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -124,9 +161,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface method override adds a non-browsable, design-time only boolean property named "TrayLargeIcon" to this designer's component at design time. This property is used by the component tray.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adjusts the set of properties the component will expose through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the properties for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -147,10 +191,17 @@ <Parameter Name="technology" Type="System.ComponentModel.Design.ViewTechnology" /> </Parameters> <Docs> - <param name="technology">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IRootDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="T:System.ComponentModel.Design.ViewTechnology" />.</para> + </summary> + <param name="technology"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.ViewTechnology" /> that indicates a particular view technology.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IRootDesigner.SupportedTechnologies"> @@ -164,9 +215,15 @@ <ReturnType>System.ComponentModel.Design.ViewTechnology[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IRootDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.ComponentModel.Design.IRootDesigner.SupportedTechnologies" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.ITypeDescriptorFilterService.FilterAttributes"> @@ -184,11 +241,19 @@ <Parameter Name="attributes" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="attributes">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.ITypeDescriptorFilterService" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.ITypeDescriptorFilterService.FilterAttributes(System.ComponentModel.IComponent,System.Collections.IDictionary)" />.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to filter the attributes of.</param> + <param name="attributes"> + <attribution license="cc4" from="Microsoft" modified="false" />A dictionary of attributes that can be modified.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.ITypeDescriptorFilterService.FilterEvents"> @@ -206,11 +271,19 @@ <Parameter Name="events" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="events">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.ITypeDescriptorFilterService" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.ITypeDescriptorFilterService.FilterEvents(System.ComponentModel.IComponent,System.Collections.IDictionary)" />.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to filter events for.</param> + <param name="events"> + <attribution license="cc4" from="Microsoft" modified="false" />A dictionary of events that can be modified.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.ITypeDescriptorFilterService.FilterProperties"> @@ -228,11 +301,19 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="properties">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.ITypeDescriptorFilterService" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.Design.ITypeDescriptorFilterService.FilterProperties(System.ComponentModel.IComponent,System.Collections.IDictionary)" />.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to filter properties for.</param> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />A dictionary of properties that can be modified.</param> </Docs> </Member> <Member MemberName="System.Drawing.Design.IToolboxUser.GetToolSupported"> @@ -249,10 +330,17 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> instance is cast to an <see cref="T:System.Drawing.Design.IToolboxUser" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Drawing.Design.IToolboxUser.GetToolSupported(System.Drawing.Design.ToolboxItem)" />.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to be tested for toolbox support.</param> </Docs> </Member> <Member MemberName="System.Drawing.Design.IToolboxUser.ToolPicked"> @@ -269,9 +357,16 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.ComponentDocumentDesigner" /> instance is cast to an <see cref="T:System.Drawing.Design.IToolboxUser" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Drawing.Design.IToolboxUser.ToolPicked(System.Drawing.Design.ToolboxItem)" />.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to select.</param> </Docs> </Member> <Member MemberName="System.Windows.Forms.Design.IOleDragClient.AddComponent"> @@ -394,9 +489,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 the component tray for the designer is in auto-arrange mode.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -410,9 +508,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 the component tray for the designer is in large icon mode.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -420,4 +521,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ComponentTray.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ComponentTray.xml index ce75e33685c..463e7babb8b 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ComponentTray.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ComponentTray.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ComponentTray" FullName="System.Windows.Forms.Design.ComponentTray"> <TypeSignature Language="C#" Value="public class ComponentTray : System.Windows.Forms.ScrollableControl, System.ComponentModel.IExtenderProvider" /> <AssemblyInfo> @@ -25,8 +26,16 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The component tray represents components that do not otherwise provide a visible surface at design time and provides a way for users to access and set the properties of those components.</para> + <para>Some types of components, such as a <see cref="T:System.Timers.Timer" />, may not have a user interface that can be viewed at design time. These components are usually represented by icons that are shown in the component tray.</para> + <para>The component tray is a rectangular region displayed at the bottom of the design view window while in design view mode, once it is active. The component tray becomes active in design view after a component that is displayed in the component tray has been added to or is part of the current document.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides behavior for the component tray of a designer. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -37,10 +46,18 @@ <Parameter Name="serviceProvider" Type="System.IServiceProvider" /> </Parameters> <Docs> - <param name="mainDesigner">To be added.</param> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The component tray monitors component additions and removals and displays appropriate user interface objects to represent the components it contains.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.Design.ComponentTray" /> class using the specified designer and service provider.</para> + </summary> + <param name="mainDesigner"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.IDesigner" /> that is the main or document designer for the current project. </param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> that can be used to obtain design-time services. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -57,9 +74,13 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds a component to the tray.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to add to the tray. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -73,9 +94,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 the tray items are automatically aligned.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -92,10 +116,14 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the specified tool can be used to create a new component.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to test. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -112,10 +140,17 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method tests the specified component for the existence of a <see cref="T:System.ComponentModel.DesignTimeVisibleAttribute" />, which indicates whether the component has a user interface that can be displayed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the specified component can be displayed.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to test. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -129,9 +164,12 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of components contained in the tray.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -148,9 +186,16 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method checks the item for an appropriate <see cref="T:System.ComponentModel.DesignTimeVisibleAttribute" /> before attempting to create the component and add it to the component tray.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a component from the specified toolbox item, adds the component to the current document, and displays a representation for the component in the component tray.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to create a component from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -167,9 +212,13 @@ <Parameter Name="e" Type="System.Exception" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays an error message to the user with information about the specified exception.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The exception about which to display information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -186,9 +235,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.Windows.Forms.Design.ComponentTray" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.Windows.Forms.Design.ComponentTray" /> and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -205,10 +262,18 @@ <Parameter Name="receiver" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="receiver">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="M:System.Windows.Forms.Design.ComponentTray.GetLocation(System.ComponentModel.IComponent)" /> is an accessor method for the location extender property that is added to each component in the component tray.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the location of the specified component, relative to the upper-left corner of the component tray.</para> + </summary> + <param name="receiver"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to retrieve the location of. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -246,11 +311,16 @@ <Parameter Name="forward" Type="System.Boolean" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <param name="forward">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Similar to <see cref="M:System.Windows.Forms.Control.GetNextControl(System.Windows.Forms.Control,System.Boolean)" />, this method returns the next component in the tray, given a starting component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component from which to start enumerating.</param> + <param name="forward"> + <attribution license="cc4" from="Microsoft" modified="false" />true to enumerate forward through the list; otherwise, false to enumerate backward.</param> </Docs> </Member> <Member MemberName="GetService"> @@ -264,9 +334,12 @@ </Parameters> <Docs> <param name="service">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the requested service type.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -300,10 +373,17 @@ <Parameter Name="receiver" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="receiver">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The Location extender property is offered to all non-visual components. The returned value takes into account the value of <see cref="P:System.Windows.Forms.ScrollableControl.AutoScrollPosition" />. If <paramref name="receiver" /> does not have a component view, the returned value is an empty <see cref="T:System.Drawing.Point" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the value of the Location extender property.</para> + </summary> + <param name="receiver"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> that receives the location extender property.</param> </Docs> </Member> <Member MemberName="IsTrayComponent"> @@ -319,10 +399,14 @@ <Parameter Name="comp" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="comp">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Tests a component for presence in the component tray.</para> + </summary> + <param name="comp"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to test for presence in the component tray.</param> </Docs> </Member> <Member MemberName="OnDoubleClick"> @@ -353,9 +437,13 @@ <Parameter Name="de" Type="System.Windows.Forms.DragEventArgs" /> </Parameters> <Docs> - <param name="de">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when an object that has been dragged is dropped on the component tray.</para> + </summary> + <param name="de"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DragEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -372,9 +460,13 @@ <Parameter Name="de" Type="System.Windows.Forms.DragEventArgs" /> </Parameters> <Docs> - <param name="de">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when an object is dragged over, and has entered the area over, the component tray.</para> + </summary> + <param name="de"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DragEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -391,9 +483,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when an object is dragged out of the area over the component tray.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -410,9 +506,13 @@ <Parameter Name="de" Type="System.Windows.Forms.DragEventArgs" /> </Parameters> <Docs> - <param name="de">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when an object is dragged over the component tray.</para> + </summary> + <param name="de"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DragEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -429,9 +529,13 @@ <Parameter Name="gfevent" Type="System.Windows.Forms.GiveFeedbackEventArgs" /> </Parameters> <Docs> - <param name="gfevent">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called during an OLE drag and drop operation to provide an opportunity for the component tray to give feedback to the user about the results of dropping the object at a specific point.</para> + </summary> + <param name="gfevent"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.GiveFeedbackEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -448,9 +552,13 @@ <Parameter Name="levent" Type="System.Windows.Forms.LayoutEventArgs" /> </Parameters> <Docs> - <param name="levent">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises the <see cref="E:System.Windows.Forms.Control.Layout" /> event.</para> + </summary> + <param name="levent"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.LayoutEventArgs" /> that contains the event data.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -465,8 +573,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when a mouse drag selection operation is canceled.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -486,9 +597,13 @@ <Parameter Name="e" Type="System.Windows.Forms.MouseEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the mouse is double clicked over the component tray.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that provides data for the event.</param> </Docs> </Member> <Member MemberName="OnMouseDown"> @@ -501,9 +616,13 @@ <Parameter Name="e" Type="System.Windows.Forms.MouseEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the mouse button is pressed.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -520,9 +639,13 @@ <Parameter Name="e" Type="System.Windows.Forms.MouseEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the mouse cursor position has changed.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -539,9 +662,13 @@ <Parameter Name="e" Type="System.Windows.Forms.MouseEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the mouse button has been released.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -558,9 +685,13 @@ <Parameter Name="pe" Type="System.Windows.Forms.PaintEventArgs" /> </Parameters> <Docs> - <param name="pe">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the view for the component tray should be refreshed.</para> + </summary> + <param name="pe"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.PaintEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -575,8 +706,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called to set the mouse cursor.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -593,9 +727,13 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified component from the tray.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to remove from the tray. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -613,10 +751,15 @@ <Parameter Name="location" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="receiver">To be added.</param> - <param name="location">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the location of the specified component to the specified location.</para> + </summary> + <param name="receiver"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to set the location of. </param> + <param name="location"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Point" /> indicating the new location for the specified component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -637,10 +780,18 @@ <Parameter Name="location" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="receiver">To be added.</param> - <param name="location">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The Location extender property is offered to all non-visual components. The actual value takes into account the value of <see cref="P:System.Windows.Forms.ScrollableControl.AutoScrollPosition" />. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the value of the Location extender property.</para> + </summary> + <param name="receiver"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> that receives the location extender property.</param> + <param name="location"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Point" /> representing the location of <paramref name="receiver" />. </param> </Docs> </Member> <Member MemberName="ShowLargeIcons"> @@ -650,9 +801,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 the tray displays a large icon to represent each component in the tray.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -673,10 +827,17 @@ <Parameter Name="component" Type="System.Object" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.ComponentTray" /> instance is cast to an <see cref="T:System.ComponentModel.IExtenderProvider" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.ComponentModel.IExtenderProvider.CanExtend(System.Object)" />.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> to receive the extender properties.</param> </Docs> </Member> <Member MemberName="WndProc"> @@ -699,4 +860,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ControlDesigner.xml index 03aaa7edc1a..16451f75d7d 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ControlDesigner" FullName="System.Windows.Forms.Design.ControlDesigner"> <TypeSignature Language="C#" Value="public class ControlDesigner : System.ComponentModel.Design.ComponentDesigner, System.Windows.Forms.Design.IMessageReceiver" /> <AssemblyInfo> @@ -14,8 +15,16 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> provides a base class for designers of components that derive from <see cref="T:System.Windows.Forms.Control" />. In addition to the methods and functionality inherited from the <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class, <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> provides additional methods to support extending and altering the behavior of an associated <see cref="T:System.Windows.Forms.Control" /> at design time.</para> + <para>You can associate a designer with a type using a <see cref="T:System.ComponentModel.DesignerAttribute" />. For an overview of customizing design time behavior, see <format type="text/html"><a href="d6ac8a6a-42fd-4bc8-bf33-b212811297e2">Extending Design-Time Support</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends the design mode behavior of a <see cref="T:System.Windows.Forms.Control" />.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -23,8 +32,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.ControlDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,8 +50,14 @@ <ReturnType>System.Windows.Forms.AccessibleObject</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default value is null.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the accessibility object for the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -53,9 +71,15 @@ <ReturnType>System.Windows.Forms.AccessibleObject</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For more information about accessible objects, see the Active Accessibility section of the MSDN Library.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Windows.Forms.AccessibleObject" /> assigned to the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -69,9 +93,17 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This property indicates any components to copy or move along with the component managed by the designer during a copy, drag, or move operation.</para> + <para>If this collection contains references to other components in the current design mode document, those components will be copied along with the component managed by the designer during a copy operation.</para> + <para>When the component managed by the designer is selected, this collection is filled with any nested controls. This collection can also include other components, such as the buttons of a toolbar.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the collection of components associated with the component managed by the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -88,9 +120,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 resize handle allocation depends on the value of the <see cref="P:System.Windows.Forms.Control.AutoSize" /> property. </para> + </summary> </Docs> </Member> <Member MemberName="BaseWndProc"> @@ -122,9 +157,12 @@ <ReturnType>System.Windows.Forms.Design.Behavior.BehaviorService</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorService" /> from the design environment.</para> + </summary> </Docs> </Member> <Member MemberName="CanBeParentedTo"> @@ -137,10 +175,20 @@ <Parameter Name="parentDesigner" Type="System.ComponentModel.Design.IDesigner" /> </Parameters> <Docs> - <param name="parentDesigner">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is useful for testing whether a control can be parented by a particular type of parent. For example, <see cref="T:System.Windows.Forms.TabPage" /> controls can only be parented by <see cref="T:System.Windows.Forms.TabControl" /> controls.</para> + <block subset="none" type="note"> + <para>This method is not called when an item is dragged from the <ui>Toolbox</ui> onto the design surface.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates if this designer's control can be parented by the control of the specified designer.</para> + </summary> + <param name="parentDesigner"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.Design.IDesigner" /> that manages the control to check. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -154,9 +202,12 @@ <ReturnType>System.Windows.Forms.Control</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the control that the designer is designing.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -192,9 +243,13 @@ <Parameter Name="e" Type="System.Exception" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Displays information about the specified exception to the user.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Exception" /> to display. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -211,9 +266,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -234,11 +297,21 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <param name="child">To be added.</param> - <param name="name">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The child control specified by <paramref name="child" /> is a child of this control designer's control. The child does not directly participate in persistence, but it will if it is exposed as a property of the main control. Consider a control like the <see cref="T:System.Windows.Forms.SplitContainer" />: it has two panels, Panel1 and Panel2. These panels are exposed through read only <see cref="P:System.Windows.Forms.SplitContainer.Panel1" /> and <see cref="P:System.Windows.Forms.SplitContainer.Panel2" /> properties on the <see cref="T:System.Windows.Forms.SplitContainer" /> control. The <see cref="T:System.Windows.Forms.SplitContainer" /> control's designer calls <see cref="M:System.Windows.Forms.Design.ControlDesigner.EnableDesignMode(System.Windows.Forms.Control,System.String)" /> for each panel, which allows other components to be dropped on them. But, in order for the contents of <see cref="P:System.Windows.Forms.SplitContainer.Panel1" /> and <see cref="P:System.Windows.Forms.SplitContainer.Panel2" /> to be saved, the <see cref="T:System.Windows.Forms.SplitContainer" /> control itself must expose the panels as public properties.</para> + <para>Control names must be unique within a control designer, but they are not required to be unique with respect to the children of other control designers. </para> + <para>To support this feature, the hosting infrastructure must expose the <see cref="T:System.ComponentModel.INestedContainer" /> class as a service through the site.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enables design time functionality for a child control.</para> + </summary> + <param name="child"> + <attribution license="cc4" from="Microsoft" modified="false" />The child control for which design mode will be enabled.</param> + <param name="name"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of <paramref name="child" /> as exposed to the end user.</param> </Docs> </Member> <Member MemberName="EnableDragDrop"> @@ -251,9 +324,16 @@ <Parameter Name="value" Type="System.Boolean" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default value of false specifies that a control cannot have children dragged onto it at design time. To allow a control to parent other controls at design time, associate it with a designer that derives from <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Enables or disables drag-and-drop support for the control being designed.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />true to enable drag-and-drop support for the control; false if the control should not have drag-and-drop support. The default is false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -267,9 +347,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether drag rectangles can be drawn on this designer component.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -289,10 +372,14 @@ <Parameter Name="selectionType" Type="System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> </Parameters> <Docs> - <param name="selectionType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a <see cref="T:System.Windows.Forms.Design.Behavior.ControlBodyGlyph" /> representing the bounds of this control.</para> + </summary> + <param name="selectionType"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> value that specifies the selection state.</param> </Docs> </Member> <Member MemberName="GetGlyphs"> @@ -308,10 +395,28 @@ <Parameter Name="selectionType" Type="System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> </Parameters> <Docs> - <param name="selectionType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Note that based on <paramref name="selectionType" />, the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects returned will represent one of these selection states:</para> + <list type="bullet"> + <item> + <para>A fully resizable selection border with grab handles;</para> + </item> + <item> + <para>A locked selection border;</para> + </item> + <item> + <para>A single 'hidden' selection <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects representing the selection borders and grab handles for a standard control.</para> + </summary> + <param name="selectionType"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> value that specifies the selection state.</param> </Docs> </Member> <Member MemberName="GetHitTest"> @@ -324,10 +429,21 @@ <Parameter Name="point" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="point">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.ControlDesigner.GetHitTest(System.Drawing.Point)" /> method determines whether a click at the specified point should be passed to the control, while the control is in design mode. You can override and implement this method to enable your control to receive clicks in the design-time environment.</para> + <block subset="none" type="note"> + <para>You can pass a point in screen coordinates to the <see cref="M:System.Windows.Forms.Control.PointToClient(System.Drawing.Point)" /> method of the <see cref="T:System.Windows.Forms.Control" /> class to obtain the coordinates of the point relative to the upper-left corner of the control.</para> + </block> + <para>The <see cref="M:System.Windows.Forms.Design.ControlDesigner.GetHitTest(System.Drawing.Point)" /> method is called in response to the WM_NCHITTEST message, so it is called on each mouse move.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether a mouse click at the specified point should be handled by the control.</para> + </summary> + <param name="point"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Point" /> indicating the position at which the mouse was clicked, in screen coordinates. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -345,8 +461,11 @@ </Parameters> <Docs> <param name="firstControl">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Routes messages from the child controls of the specified control to the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -364,9 +483,12 @@ <ReturnType>System.ComponentModel.InheritanceAttribute</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.ComponentModel.InheritanceAttribute" /> of the designer.</para> + </summary> </Docs> </Member> <Member MemberName="Initialize"> @@ -379,9 +501,16 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the designer host to initialize the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer with the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to associate the designer with. This component must always be an instance of, or derive from, <see cref="T:System.Windows.Forms.Control" />. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -401,9 +530,16 @@ <Parameter Name="defaultValues" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="defaultValues">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> class overrides this method to handle after-drop cases.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Re-initializes an existing component.</para> + </summary> + <param name="defaultValues"> + <attribution license="cc4" from="Microsoft" modified="false" />A name/value dictionary of default values to apply to properties. May be null if no default values are specified.</param> </Docs> </Member> <Member MemberName="InitializeNewComponent"> @@ -419,9 +555,16 @@ <Parameter Name="defaultValues" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="defaultValues">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> class overrides this method. It will look at the default property for the control and, if it is of type string, it will set this property's value to the name of the component. It only does this if the designer has been configured with this option in the options service. This method also connects the control to its parent and positions it. If you override this method, you should always call base.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a newly created component.</para> + </summary> + <param name="defaultValues"> + <attribution license="cc4" from="Microsoft" modified="false" />A name/value dictionary of default values to apply to properties. May be null if no default values are specified.</param> </Docs> </Member> <Member MemberName="InternalControlDesigner"> @@ -437,10 +580,17 @@ <Parameter Name="internalControlIndex" Type="System.Int32" /> </Parameters> <Docs> - <param name="internalControlIndex">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An internal control is a control that is not in the <see cref="P:System.ComponentModel.IContainer.Components" /> collection of the <see cref="P:System.ComponentModel.Design.IDesignerHost.Container" />. <see cref="T:System.Windows.Forms.SplitterPanel" /> is an example of one such control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the internal control designer with the specified index in the <see cref="T:System.Windows.Forms.Design.ControlDesigner" />.</para> + </summary> + <param name="internalControlIndex"> + <attribution license="cc4" from="Microsoft" modified="false" />A specified index to select the internal control designer. This index is zero-based.</param> </Docs> </Member> <Member MemberName="InvalidPoint"> @@ -450,8 +600,15 @@ <ReturnType>System.Drawing.Point</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="F:System.Windows.Forms.Design.ControlDesigner.InvalidPoint" /> has an <see cref="P:System.Drawing.Point.X" /> and <see cref="P:System.Drawing.Point.Y" /> property set to the minimum value for the integer data type.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines a local <see cref="T:System.Drawing.Point" /> that represents the values of an invalid <see cref="T:System.Drawing.Point" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -469,9 +626,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An internal control is a control that is not in the <see cref="P:System.ComponentModel.IContainer.Components" /> collection of the <see cref="P:System.ComponentModel.Design.IDesignerHost.Container" />. <see cref="T:System.Windows.Forms.SplitterPanel" /> is an example of one such control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns the number of internal control designers in the <see cref="T:System.Windows.Forms.Design.ControlDesigner" />.</para> + </summary> </Docs> </Member> <Member MemberName="OnContextMenu"> @@ -485,10 +648,15 @@ <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> - <param name="x">To be added.</param> - <param name="y">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Shows the context menu and provides an opportunity to perform additional processing when the context menu is about to be displayed.</para> + </summary> + <param name="x"> + <attribution license="cc4" from="Microsoft" modified="false" />The x coordinate at which to display the context menu. </param> + <param name="y"> + <attribution license="cc4" from="Microsoft" modified="false" />The y coordinate at which to display the context menu. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -503,8 +671,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an opportunity to perform additional processing immediately after the control handle has been created.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -524,9 +695,13 @@ <Parameter Name="de" Type="System.Windows.Forms.DragEventArgs" /> </Parameters> <Docs> - <param name="de">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call to clean up a drag-and-drop operation.</para> + </summary> + <param name="de"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DragEventArgs" /> that provides data for the event.</param> </Docs> </Member> <Member MemberName="OnDragDrop"> @@ -540,8 +715,11 @@ </Parameters> <Docs> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call when a drag-and-drop object is dropped onto the control designer view.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -559,8 +737,11 @@ </Parameters> <Docs> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call when a drag-and-drop operation enters the control designer view.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -577,9 +758,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call when a drag-and-drop operation leaves the control designer view.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -597,8 +782,11 @@ </Parameters> <Docs> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call when a drag-and-drop object is dragged over the control designer view.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -615,9 +803,16 @@ <Parameter Name="e" Type="System.Windows.Forms.GiveFeedbackEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The designer host calls this method when an OLE drag event occurs.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call when a drag-and-drop operation is in progress to provide visual cues based on the location of the mouse while a drag operation is in progress.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.GiveFeedbackEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -635,10 +830,21 @@ <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> - <param name="x">To be added.</param> - <param name="y">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called at the start of a drag-and-drop operation.</para> + <block subset="none" type="note"> + <para>You can pass a point in screen coordinates to the <see cref="M:System.Windows.Forms.Control.PointToClient(System.Drawing.Point)" /> method of the <see cref="T:System.Windows.Forms.Control" /> class to obtain the coordinates of the point relative to the upper-left corner of the control.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call in response to the left mouse button being pressed and held while over the component.</para> + </summary> + <param name="x"> + <attribution license="cc4" from="Microsoft" modified="false" />The x position of the mouse in screen coordinates. </param> + <param name="y"> + <attribution license="cc4" from="Microsoft" modified="false" />The y position of the mouse in screen coordinates. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -655,9 +861,13 @@ <Parameter Name="cancel" Type="System.Boolean" /> </Parameters> <Docs> - <param name="cancel">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call at the end of a drag-and-drop operation to complete or cancel the operation.</para> + </summary> + <param name="cancel"> + <attribution license="cc4" from="Microsoft" modified="false" />true to cancel the drag; false to commit it. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -675,10 +885,20 @@ <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> - <param name="x">To be added.</param> - <param name="y">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <block subset="none" type="note"> + <para>You can pass a point in screen coordinates to the <see cref="M:System.Windows.Forms.Control.PointToClient(System.Drawing.Point)" /> method of the <see cref="T:System.Windows.Forms.Control" /> class to obtain the coordinates of the point relative to the upper-left corner of the control.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call for each movement of the mouse during a drag-and-drop operation.</para> + </summary> + <param name="x"> + <attribution license="cc4" from="Microsoft" modified="false" />The x position of the mouse in screen coordinates. </param> + <param name="y"> + <attribution license="cc4" from="Microsoft" modified="false" />The y position of the mouse in screen coordinates. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -693,8 +913,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call when the mouse first enters the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -709,8 +932,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call after the mouse hovers over the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -725,8 +951,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call when the mouse first enters the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -743,9 +972,13 @@ <Parameter Name="pe" Type="System.Windows.Forms.PaintEventArgs" /> </Parameters> <Docs> - <param name="pe">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call when the control that the designer is managing has painted its surface so the designer can paint any additional adornments on top of the control.</para> + </summary> + <param name="pe"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.PaintEventArgs" /> the designer can use to draw on the control. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -760,8 +993,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the designer is intialized.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -776,8 +1012,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method handles redirection and handling of the set cursor event. If the toolbox service has a tool selected, this method will allow the toolbox service to set the cursor. If the selection UI service has a locked selection, or if there is no location property on the control, the default arrow cursor will be set. If a user is dragging a component, the crosshair cursor will be set. Otherwise, a four headed arrow cursor will be set to indicate that the component can be clicked and moved.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Receives a call each time the cursor needs to be set.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -794,9 +1036,15 @@ <ReturnType>System.ComponentModel.IComponent</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default implementation simply checks to see if the component being designed is a control and if it is, <see cref="P:System.Windows.Forms.Design.ControlDesigner.ParentComponent" /> returns its parent.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the parent component for the <see cref="T:System.Windows.Forms.Design.ControlDesigner" />.</para> + </summary> </Docs> </Member> <Member MemberName="ParticipatesWithSnapLines"> @@ -809,9 +1057,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> will allow snapline alignment during a drag operation.</para> + </summary> </Docs> </Member> <Member MemberName="PreFilterProperties"> @@ -824,9 +1075,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface method override adds a set of properties to this designer's component at design time. This method adds the following browsable properties: Visible, Enabled, ContextMenu, AllowDrop, Location, Name, Controls, and Locked.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adjusts the set of properties the component exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> containing the properties for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -840,9 +1098,15 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If no designer provides rules for a component, the component will not get any UI services.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the selection rules that indicate the movement capabilities of a component.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -859,9 +1123,15 @@ <ReturnType>System.Collections.IList</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You can use the offered <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> objects to assist in positioning the control on a design surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a list of <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> objects representing significant alignment points for this control.</para> + </summary> </Docs> </Member> <Member MemberName="System.Windows.Forms.Design.IMessageReceiver.WndProc"> @@ -894,8 +1164,11 @@ </Parameters> <Docs> <param name="firstControl">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Routes messages for the children of the specified control to each control rather than to a parent designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -922,4 +1195,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DesignerOptions.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DesignerOptions.xml index e59b863c075..f7ab6e57d54 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DesignerOptions.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DesignerOptions.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DesignerOptions" FullName="System.Windows.Forms.Design.DesignerOptions"> <TypeSignature Language="C#" Value="public class DesignerOptions" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides access to get and set option values for a designer.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.DesignerOptions" /> class. </para> + </summary> </Docs> </Member> <Member MemberName="EnableInSituEditing"> @@ -40,9 +47,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value that enables or disables in-place editing for <see cref="T:System.Windows.Forms.ToolStrip" /> controls.</para> + </summary> </Docs> </Member> <Member MemberName="GridSize"> @@ -55,9 +65,12 @@ <ReturnType>System.Drawing.Size</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a <see cref="T:System.Drawing.Size" /> representing the dimensions of a grid unit. </para> + </summary> </Docs> </Member> <Member MemberName="ObjectBoundSmartTagAutoShow"> @@ -70,9 +83,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A component's smart tag panel is set to automatically open when the <see cref="P:System.ComponentModel.Design.DesignerActionList.AutoShow" /> property is true. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value that specifies whether a designer shows a component's smart tag panel automatically on creation. </para> + </summary> </Docs> </Member> <Member MemberName="ShowGrid"> @@ -85,9 +104,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value that enables or disables the grid in the designer. </para> + </summary> </Docs> </Member> <Member MemberName="SnapToGrid"> @@ -100,9 +122,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value that enables or disables whether controls are automatically placed at grid coordinates. </para> + </summary> </Docs> </Member> <Member MemberName="UseOptimizedCodeGeneration"> @@ -115,9 +140,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The component cache is a performance enhancement that is incompatible with certain designers. You can disable it with this property.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value that enables or disables the component cache. </para> + </summary> </Docs> </Member> <Member MemberName="UseSmartTags"> @@ -130,9 +161,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This option is not exposed on the <ui>Options</ui> item of the <ui>Tools</ui> menu in vsprvs.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value that enables or disables smart tags in the designer.</para> + </summary> </Docs> </Member> <Member MemberName="UseSnapLines"> @@ -145,10 +182,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value that enables or disables snaplines in the designer.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DockEditor.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DockEditor.xml index e8b33c80975..33a7df14059 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DockEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DockEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DockEditor" FullName="System.Windows.Forms.Design.DockEditor"> <TypeSignature Language="C#" Value="public sealed class DockEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for specifying a <see cref="P:System.Windows.Forms.Control.Dock" /> property.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +23,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.DockEditor" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,12 +46,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the specified object value using the editor style provided by GetEditorStyle. A service provider is provided so that any required editing services can be obtained.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which editing services may be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the value being edited. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,10 +74,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Retrieves the editing style of the EditValue method. If the method is not supported, this will return None.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -72,4 +89,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DocumentDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DocumentDesigner.xml index 002ed3e4501..66d07c0f97f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DocumentDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/DocumentDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="DocumentDesigner" FullName="System.Windows.Forms.Design.DocumentDesigner"> <TypeSignature Language="C#" Value="public class DocumentDesigner : System.Windows.Forms.Design.ScrollableControlDesigner, System.ComponentModel.Design.IRootDesigner, System.Drawing.Design.IToolboxUser" /> <AssemblyInfo> @@ -17,8 +18,15 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This designer is a root designer, meaning that it provides the root-level design mode view for the associated document when it is viewed in design mode.</para> + <para>You can associate a designer with a type using a <see cref="T:System.ComponentModel.DesignerAttribute" />. For an overview of customizing design time behavior, see <format type="text/html"><a href="d6ac8a6a-42fd-4bc8-bf33-b212811297e2">Extending Design-Time Support</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Base designer class for extending the design mode behavior of, and providing a root-level design mode view for, a <see cref="T:System.Windows.Forms.Control" /> that supports nested controls and should receive scroll messages.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -26,8 +34,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.DocumentDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -44,9 +55,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.Windows.Forms.Design.DocumentDesigner" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.Windows.Forms.Design.DocumentDesigner" /> and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -64,8 +83,11 @@ </Parameters> <Docs> <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Checks for the existence of a menu editor service and creates one if one does not already exist.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -85,10 +107,14 @@ <Parameter Name="selectionType" Type="System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> </Parameters> <Docs> - <param name="selectionType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a <see cref="T:System.Windows.Forms.Design.Behavior.GlyphCollection" /> representing the <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects.</para> + </summary> + <param name="selectionType"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> value that specifies the selection state.</param> </Docs> </Member> <Member MemberName="GetToolSupported"> @@ -101,10 +127,17 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If a tool is supported, it will be enabled in the toolbox when the designer receives focus. Otherwise, it will be disabled. Once a tool is marked as enabled or disabled it can not be queried again.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the specified tool is supported by the designer.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to test for toolbox support. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -121,9 +154,13 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer with the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to associate with the designer. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -137,8 +174,11 @@ <ReturnType>System.Windows.Forms.Design.IMenuEditorService</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the menuEditorService variable to null.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -156,10 +196,18 @@ <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> - <param name="x">To be added.</param> - <param name="y">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method displays the context menu of the document designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the context menu should be displayed.</para> + </summary> + <param name="x"> + <attribution license="cc4" from="Microsoft" modified="false" />The horizontal screen coordinate to display the context menu at. </param> + <param name="y"> + <attribution license="cc4" from="Microsoft" modified="false" />The vertical screen coordinate to display the context menu at. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -174,8 +222,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called immediately after the handle for the designer has been created.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -207,9 +258,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface method override adds a set of properties to this designer's component at design time. This method adds the following browsable properties: "Location", and "BackColor".</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adjusts the set of properties the component exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the properties for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -223,9 +281,15 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method returns a <see cref="T:System.Windows.Forms.Design.SelectionRules" /> that prevents the document from being resized.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Windows.Forms.Design.SelectionRules" /> for the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -246,10 +310,17 @@ <Parameter Name="technology" Type="System.ComponentModel.Design.ViewTechnology" /> </Parameters> <Docs> - <param name="technology">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.DocumentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IRootDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="T:System.ComponentModel.Design.ViewTechnology" />.</para> + </summary> + <param name="technology"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.ViewTechnology" /> that indicates a particular view technology.</param> </Docs> </Member> <Member MemberName="System.ComponentModel.Design.IRootDesigner.SupportedTechnologies"> @@ -263,9 +334,15 @@ <ReturnType>System.ComponentModel.Design.ViewTechnology[]</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.DocumentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IRootDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="P:System.ComponentModel.Design.IRootDesigner.SupportedTechnologies" />.</para> + </summary> </Docs> </Member> <Member MemberName="System.Drawing.Design.IToolboxUser.GetToolSupported"> @@ -282,10 +359,17 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.DocumentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IRootDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Drawing.Design.IToolboxUser.GetToolSupported(System.Drawing.Design.ToolboxItem)" />.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to be tested for toolbox support.</param> </Docs> </Member> <Member MemberName="System.Drawing.Design.IToolboxUser.ToolPicked"> @@ -302,9 +386,16 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.Design.DocumentDesigner" /> instance is cast to an <see cref="T:System.ComponentModel.Design.IRootDesigner" /> interface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>For a description of this member, see <see cref="M:System.Drawing.Design.IToolboxUser.ToolPicked(System.Drawing.Design.ToolboxItem)" />.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to select.</param> </Docs> </Member> <Member MemberName="ToolPicked"> @@ -317,9 +408,17 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="M:System.Drawing.Design.IToolboxUser.ToolPicked(System.Drawing.Design.ToolboxItem)" /> is called when the user double-clicks on a toolbox item. The document designer should create a component for the specified tool. Only tools that are enabled in the toolbox will be passed to this method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Selects the specified tool.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to create a component for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -351,4 +450,4 @@ <AttributeName>System.ComponentModel.ToolboxItemFilter("System.Windows.Forms")</AttributeName> </Attribute> </Attributes> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/EventHandlerService.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/EventHandlerService.xml index e2eb83652c9..865323057ff 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/EventHandlerService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/EventHandlerService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="EventHandlerService" FullName="System.Windows.Forms.Design.EventHandlerService"> <TypeSignature Language="C#" Value="public sealed class EventHandlerService" /> <AssemblyInfo> @@ -10,8 +11,19 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Developers may want to be able to write code in one place that handles events of a certain type.</para> + <para>Also, developers may need to globally change the behavior of the handlers for specific events or types of events, which may be distributed among designer components.</para> + <para>The designers for a typical project are many different objects so it can be useful to list and store reference to these events from a common place.</para> + <para>This service implements an "event stack" that contains the current set of event handlers. The stack may have a variety of different types of handlers on the stack.</para> + <para>For example, a designer might push, or add, a keyboard handler and a mouse handler onto the stack. When a designer requests an event handler, the service will find the topmost handler on the stack that matches the class you requested.</para> + <para>This way the service can be extended to any eventing scheme, and it also allows specific types of event handlers to be replaced. For example, you can replace mouse event handlers without affecting menu event handlers or keyboard event handlers.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a systematic way to manage event handlers for the current document.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,9 +33,13 @@ <Parameter Name="focusWnd" Type="System.Windows.Forms.Control" /> </Parameters> <Docs> - <param name="focusWnd">To be added.</param> - <summary>To be added.</summary> <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.Design.EventHandlerService" /> class. </para> + </summary> + <param name="focusWnd"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Control" /> which is being designed.</param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -37,8 +53,11 @@ <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Fires an OnEventHandlerChanged event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -52,9 +71,12 @@ <ReturnType>System.Windows.Forms.Control</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the control to which event handlers are attached.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -71,10 +93,17 @@ <Parameter Name="handlerType" Type="System.Type" /> </Parameters> <Docs> - <param name="handlerType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You should never cache this value because other components are free to change it. This call is fairly quick, however, especially for cases when you are always asking for the same type of handler.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the currently active event handler of the specified type.</para> + </summary> + <param name="handlerType"> + <attribution license="cc4" from="Microsoft" modified="false" />The type of the handler to get. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -91,9 +120,16 @@ <Parameter Name="handler" Type="System.Object" /> </Parameters> <Docs> - <param name="handler">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the handler is not the topmost component on the stack, this will pop all handlers up to and including handler.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Pops the given handler off of the stack.</para> + </summary> + <param name="handler"> + <attribution license="cc4" from="Microsoft" modified="false" />The handler to remove from the stack. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -110,9 +146,16 @@ <Parameter Name="handler" Type="System.Object" /> </Parameters> <Docs> - <param name="handler">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This handler will be used by all components that request a compatible handler type. If this handler does not support the requested type, the next handler on the stack will be used.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Pushes a new event handler on the stack.</para> + </summary> + <param name="handler"> + <attribution license="cc4" from="Microsoft" modified="false" />The handler to add to the stack. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -120,4 +163,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/FileNameEditor.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/FileNameEditor.xml index 5f96b5f99d4..7c79f07d4e6 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/FileNameEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/FileNameEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="FileNameEditor" FullName="System.Windows.Forms.Design.FileNameEditor"> <TypeSignature Language="C#" Value="public class FileNameEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Windows.Forms.Design.FileNameEditor" /> provides a file selection dialog box for file name selection and editing.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for selecting a file name.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.FileNameEditor" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,12 +50,21 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A service provider is provided so that any required editing services can be obtained.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the specified object using the editor style provided by the <see cref="M:System.Windows.Forms.Design.FileNameEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which editing services may be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An instance of the value being edited. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,10 +81,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="M:System.Windows.Forms.Design.FileNameEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method is not supported, this method will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editing style used by the <see cref="M:System.Windows.Forms.Design.FileNameEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -81,9 +108,16 @@ <Parameter Name="openFileDialog" Type="System.Windows.Forms.OpenFileDialog" /> </Parameters> <Docs> - <param name="openFileDialog">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method configures the dialog box with a generic file filter and title.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the open file dialog when it is created.</para> + </summary> + <param name="openFileDialog"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.OpenFileDialog" /> to use to select a file name. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -91,4 +125,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/FolderNameEditor.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/FolderNameEditor.xml index 6050ecbf9b7..8eff80bca5f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/FolderNameEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/FolderNameEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="FolderNameEditor" FullName="System.Windows.Forms.Design.FolderNameEditor"> <TypeSignature Language="C#" Value="public class FolderNameEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -10,8 +11,14 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>You may customize the folder options by inheriting from this class and overriding <see cref="M:System.Windows.Forms.Design.FolderNameEditor.InitializeDialog(System.Windows.Forms.Design.FolderNameEditor.FolderBrowser)" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a user interface for choosing a folder from the file system.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +26,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.FolderNameEditor" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,12 +49,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the specified object using the editor style provided by <see cref="M:System.Windows.Forms.Design.FolderNameEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" />.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />A service object provider. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The value to set. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -61,10 +77,17 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the <see cref="M:System.Windows.Forms.Design.FolderNameEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method is not supported, this will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editing style used by the <see cref="M:System.Windows.Forms.Design.FolderNameEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -91,4 +114,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/IMenuEditorService.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/IMenuEditorService.xml index 22f88a6fc98..0adf90a2d15 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/IMenuEditorService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/IMenuEditorService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IMenuEditorService" FullName="System.Windows.Forms.Design.IMenuEditorService"> <TypeSignature Language="C#" Value="public interface IMenuEditorService" /> <AssemblyInfo> @@ -7,8 +8,14 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Most of the implementation of this service is provided by the host environment.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides access to the menu editing service.</para> + </summary> </Docs> <Members> <Member MemberName="GetMenu"> @@ -19,9 +26,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the current menu.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -36,9 +46,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the current menu is active.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -75,9 +88,16 @@ <Parameter Name="menu" Type="System.Windows.Forms.Menu" /> </Parameters> <Docs> - <param name="menu">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The menu is painted at the top of a form's window frame and can be directly edited by the user.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the specified menu visible on the form.</para> + </summary> + <param name="menu"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Menu" /> to render. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -94,9 +114,13 @@ <Parameter Name="item" Type="System.Windows.Forms.MenuItem" /> </Parameters> <Docs> - <param name="item">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the selected menu item of the current menu.</para> + </summary> + <param name="item"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MenuItem" /> to set as the currently selected menu item. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -104,4 +128,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ImageListCodeDomSerializer.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ImageListCodeDomSerializer.xml index e8b4bb7d721..9e2e5b3b223 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ImageListCodeDomSerializer.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ImageListCodeDomSerializer.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ImageListCodeDomSerializer" FullName="System.Windows.Forms.Design.ImageListCodeDomSerializer"> <TypeSignature Language="C#" Value="public class ImageListCodeDomSerializer : System.ComponentModel.Design.Serialization.CodeDomSerializer" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes string dictionaries.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.ImageListCodeDomSerializer" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Deserialize"> @@ -39,11 +46,19 @@ <Parameter Name="codeObject" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="codeObject">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.ImageListCodeDomSerializer.Deserialize(System.ComponentModel.Design.Serialization.IDesignerSerializationManager,System.Object)" /> method uses the serialization manager to create objects and resolve data types.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Deserializes the specified serialized Code Document Object Model (CodeDOM) object into an object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />A serialization manager interface that is used during the deserialization process.</param> + <param name="codeObject"> + <attribution license="cc4" from="Microsoft" modified="false" />A serialized CodeDOM object to deserialize.</param> </Docs> </Member> <Member MemberName="Serialize"> @@ -60,12 +75,17 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="manager">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Serializes the specified object into a Code Document Object Model (CodeDOM) object.</para> + </summary> + <param name="manager"> + <attribution license="cc4" from="Microsoft" modified="false" />The serialization manager to use during serialization.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to serialize.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ImageListImageEditor.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ImageListImageEditor.xml index 5103b278389..0867a0736ce 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ImageListImageEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ImageListImageEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ImageListImageEditor" FullName="System.Windows.Forms.Design.ImageListImageEditor"> <TypeSignature Language="C#" Value="public class ImageListImageEditor : System.Drawing.Design.ImageEditor" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an editor that can perform default file searching for bitmap (.bmp) files.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.ImageListImageEditor" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="EditValue"> @@ -40,12 +47,21 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This editor uses a service provider to obtain any necessary editing services.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the specified object value using the edit style provided by the <see cref="M:System.Drawing.Design.ImageEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information. </param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> through which editing services can be obtained. </param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> being edited. </param> </Docs> </Member> <Member MemberName="GetFileDialogDescription"> @@ -59,9 +75,15 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The file dialog box description appears in the file-list filter drop-down list box.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the description for the default file-list filter provided by this editor.</para> + </summary> </Docs> </Member> <Member MemberName="GetImageExtenders"> @@ -75,9 +97,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an array of supported image types.</para> + </summary> </Docs> </Member> <Member MemberName="GetPaintValueSupported"> @@ -93,10 +118,14 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether this editor supports painting a representation of an object's value.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information.</param> </Docs> </Member> <Member MemberName="PaintValue"> @@ -112,10 +141,17 @@ <Parameter Name="e" Type="System.Drawing.Design.PaintValueEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>To display the representation of the value in the typical property sheet format, paint within the boundaries of the <see cref="T:System.Drawing.Rectangle" /> contained within the specified <see cref="T:System.Drawing.Design.PaintValueEventArgs" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Paints a value indicated by the specified <see cref="T:System.Drawing.Design.PaintValueEventArgs" />.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Design.PaintValueEventArgs" /> indicating what to paint and where to paint it.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/MaskDescriptor.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/MaskDescriptor.xml index 465ae2a410c..3ff2771d1b1 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/MaskDescriptor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/MaskDescriptor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MaskDescriptor" FullName="System.Windows.Forms.Design.MaskDescriptor"> <TypeSignature Language="C#" Value="public abstract class MaskDescriptor" /> <AssemblyInfo> @@ -9,8 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:System.Windows.Forms.Design.MaskDescriptor" /> abstract class defines the common set of properties that all mask descriptors must implement. You can use mask descriptors to create predefined mask options for use in the UI type editor for the <see cref="T:System.Windows.Forms.MaskedTextBox" />. For example, vsprvs provides predefined masks for data such as the Postal Code, time, different date formats, and telephone number. All predefined masks will be associated with the <see cref="T:System.ComponentModel.MaskedTextProvider" /> parsing engine.</para> + <para>You can discover <see cref="T:System.Windows.Forms.Design.MaskDescriptor" /> types at design time by querying the <see cref="T:System.ComponentModel.Design.ITypeDiscoveryService" /> service provider. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines a set of members for derived classes to provide options for the masked text box UI type editor.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +29,15 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="M:System.Windows.Forms.Design.MaskDescriptor.#ctor" /> is a compiler-supplied default constructor. A default constructor is required by the <see cref="T:System.ComponentModel.Design.ITypeDiscoveryService" /> service provider.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.Design.MaskDescriptor" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="Culture"> @@ -35,9 +50,12 @@ <ReturnType>System.Globalization.CultureInfo</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Globalization.CultureInfo" /> representing the locale the mask is authored for.</para> + </summary> </Docs> </Member> <Member MemberName="Equals"> @@ -53,10 +71,23 @@ <Parameter Name="maskDescriptor" Type="System.Object" /> </Parameters> <Docs> - <param name="maskDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.MaskDescriptor.Equals(System.Object)" /> method determines whether <paramref name="maskDescriptor" /> and the current mask descriptor describe the same mask.</para> + <para>This method returns true if the following conditions are met in both mask descriptors.</para> + <para>1. The <see cref="P:System.Windows.Forms.Design.MaskDescriptor.Mask" /> property is the same for both mask descriptors.</para> + <para>2. The validating type is the same for both mask descriptors.</para> + <block subset="none" type="note"> + <para>The <see cref="P:System.Windows.Forms.Design.MaskDescriptor.Name" /> property is not considered, because the <see cref="T:System.ComponentModel.MaskedTextProvider" /> and <see cref="T:System.Windows.Forms.MaskedTextBox" /> classes do not use it.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the specified <see cref="T:System.Windows.Forms.Design.MaskDescriptor" /> is equal to the current <see cref="T:System.Windows.Forms.Design.MaskDescriptor" />.</para> + </summary> + <param name="maskDescriptor"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.MaskDescriptor" /> to compare with the current <see cref="T:System.Windows.Forms.Design.MaskDescriptor" />.</param> </Docs> </Member> <Member MemberName="GetHashCode"> @@ -88,10 +119,38 @@ <Parameter Name="maskDescriptor" Type="System.Windows.Forms.Design.MaskDescriptor" /> </Parameters> <Docs> - <param name="maskDescriptor">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.MaskDescriptor.IsValidMaskDescriptor(System.Windows.Forms.Design.MaskDescriptor)" /> method determines whether <paramref name="maskDescriptor" /> is valid and can be added to the masks list.</para> + <para>A valid <see cref="T:System.Windows.Forms.Design.MaskDescriptor" /> must meet the following conditions.</para> + <list type="bullet"> + <item> + <para>Not null.</para> + </item> + <item> + <para>Not null or an empty mask.</para> + </item> + <item> + <para>Not null or an empty name.</para> + </item> + <item> + <para>Not null or an empty sample.</para> + </item> + <item> + <para>The sample is correct based on the mask and all required edit characters have been provided. This means the mask is completed but not necessarily full.</para> + </item> + <item> + <para>The sample is valid based on the <see cref="P:System.Windows.Forms.Design.MaskDescriptor.ValidatingType" /> object, if any. </para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value indicating whether the specified mask descriptor is valid and can be added to the masks list.</para> + </summary> + <param name="maskDescriptor"> + <attribution license="cc4" from="Microsoft" modified="false" />The mask descriptor to test for validity.</param> </Docs> </Member> <Member MemberName="IsValidMaskDescriptor"> @@ -125,9 +184,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The mask must contain only valid characters, as defined by the <see cref="M:System.ComponentModel.MaskedTextProvider.IsValidMaskChar(System.Char)" /> method of the <see cref="T:System.ComponentModel.MaskedTextProvider" /> class. When a predefined mask is selected in vsprvs, its <see cref="P:System.Windows.Forms.Design.MaskDescriptor.Mask" /> property is displayed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the mask being defined.</para> + </summary> </Docs> </Member> <Member MemberName="Name"> @@ -140,9 +205,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Windows.Forms.Design.MaskDescriptor.Name" /> property is displayed in the <ui>Mask Description</ui> column in the visual editor for the <see cref="T:System.Windows.Forms.MaskedTextBox" /> control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the user-friendly name of the mask.</para> + </summary> </Docs> </Member> <Member MemberName="Sample"> @@ -155,9 +226,15 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Windows.Forms.Design.MaskDescriptor.Sample" /> property is displayed in the <ui>Data Format</ui> column in the visual editor for the <see cref="T:System.Windows.Forms.MaskedTextBox" /> control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a sample of a formatted string for the mask.</para> + </summary> </Docs> </Member> <Member MemberName="ToString"> @@ -186,10 +263,16 @@ <ReturnType>System.Type</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Windows.Forms.Design.MaskDescriptor.ValidatingType" /> property is used to validate the input string after the mask has been applied to it. It directly corresponds to the <see cref="P:System.Windows.Forms.MaskedTextBox.ValidatingType" /> property of the <see cref="T:System.Windows.Forms.MaskedTextBox" /> class.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the type providing validation associated with the mask.</para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/MenuCommands.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/MenuCommands.xml index a0af2d54ee6..6754813d836 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/MenuCommands.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/MenuCommands.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MenuCommands" FullName="System.Windows.Forms.Design.MenuCommands"> <TypeSignature Language="C#" Value="public sealed class MenuCommands : System.ComponentModel.Design.StandardCommands" /> <AssemblyInfo> @@ -10,8 +11,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Windows.Forms.Design.MenuCommands" /> contains a set of <see cref="T:System.ComponentModel.Design.CommandID" /> fields that can be used to specify a command to link when adding a command using the <see cref="M:System.ComponentModel.Design.IMenuCommandService.AddCommand(System.ComponentModel.Design.MenuCommand)" /> method of the <see cref="T:System.ComponentModel.Design.IMenuCommandService" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines a set of <see cref="T:System.ComponentModel.Design.CommandID" /> fields that each correspond to a command function provided by the host environment.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +27,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.MenuCommands" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -34,8 +45,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the component tray menu.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -49,8 +63,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the container menu.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -64,8 +81,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the properties page for the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -82,8 +102,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the edit label handler.</para> + </summary> </Docs> </Member> <Member MemberName="KeyCancel"> @@ -93,8 +116,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the cancel key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -108,8 +134,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the default key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -126,8 +155,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the end key handler.</para> + </summary> </Docs> </Member> <Member MemberName="KeyHome"> @@ -140,8 +172,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the home key handler.</para> + </summary> </Docs> </Member> <Member MemberName="KeyInvokeSmartTag"> @@ -154,8 +189,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the smart tag invocation handler.</para> + </summary> </Docs> </Member> <Member MemberName="KeyMoveDown"> @@ -165,8 +203,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the move down key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -180,8 +221,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the move left key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -195,8 +239,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the move right key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -210,8 +257,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the move up key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -225,8 +275,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the nudge down key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -240,8 +293,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the nudge height decrease key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -255,8 +311,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the nudge height increase key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -270,8 +329,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the nudge left key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -285,8 +347,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the nudge right key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -300,8 +365,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the nudge up key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -315,8 +383,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the nudge width decrease key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -330,8 +401,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the nudge width increase key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -345,8 +419,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the reverse cancel key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -360,8 +437,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the select next key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -375,8 +455,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the select previous key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -393,8 +476,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the SHIFT-END key handler.</para> + </summary> </Docs> </Member> <Member MemberName="KeyShiftHome"> @@ -407,8 +493,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the SHIFT-HOME key handler.</para> + </summary> </Docs> </Member> <Member MemberName="KeySizeHeightDecrease"> @@ -418,8 +507,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the size height decrease key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -433,8 +525,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the size height increase key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -448,8 +543,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the size width decrease key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -463,8 +561,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the size width increase key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -478,8 +579,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the tab order select key handler.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -493,8 +597,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the selection menu.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -511,8 +618,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to set the status rectangle.</para> + </summary> </Docs> </Member> <Member MemberName="SetStatusText"> @@ -525,8 +635,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to set the status rectangle text.</para> + </summary> </Docs> </Member> <Member MemberName="TraySelectionMenu"> @@ -536,8 +649,11 @@ <ReturnType>System.ComponentModel.Design.CommandID</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.ComponentModel.Design.CommandID" /> that can be used to access the tray selection menu.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -545,4 +661,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ParentControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ParentControlDesigner.xml index d5918c26a28..623cbbf6d5f 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ParentControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ParentControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ParentControlDesigner" FullName="System.Windows.Forms.Design.ParentControlDesigner"> <TypeSignature Language="C#" Value="public class ParentControlDesigner : System.Windows.Forms.Design.ControlDesigner" /> <AssemblyInfo> @@ -11,8 +12,16 @@ <Interfaces> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" /> provides a base class for designers of controls that can contain child controls. In addition to the methods and functionality inherited from the <see cref="T:System.Windows.Forms.Design.ControlDesigner" /> and <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> classes, <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" /> enables child controls to be added to, removed from, selected within, and arranged within the control whose behavior it extends at design time.</para> + <para>You can associate a designer with a type using a <see cref="T:System.ComponentModel.DesignerAttribute" />. For an overview of customizing design time behavior, see <format type="text/html"><a href="d6ac8a6a-42fd-4bc8-bf33-b212811297e2">Extending Design-Time Support</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Extends the design mode behavior of a <see cref="T:System.Windows.Forms.Control" /> that supports nested controls.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -20,8 +29,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.ParentControlDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -56,9 +68,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="P:System.Windows.Forms.Design.ParentControlDesigner.AllowControlLasso" /> method is called after the user selects a toolbox item that has a <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" /> associated with it. It draws a reversible rectangle on a designer's surface.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether selected controls will be re-parented.</para> + </summary> </Docs> </Member> <Member MemberName="AllowGenericDragBox"> @@ -71,9 +89,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether a generic drag box should be drawn when dragging a toolbox item over the designer's surface.</para> + </summary> </Docs> </Member> <Member MemberName="AllowSetChildIndexOnDrop"> @@ -86,9 +107,15 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>By default the z-order of dragged controls is maintained when dropped on a <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the z-order of dragged controls should be maintained when dropped on a <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" />.</para> + </summary> </Docs> </Member> <Member MemberName="CanParent"> @@ -101,10 +128,17 @@ <Parameter Name="control" Type="System.Windows.Forms.Control" /> </Parameters> <Docs> - <param name="control">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method indicates whether the control managed by the designer can parent the specified <see cref="T:System.Windows.Forms.Design.ControlDesigner" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the specified control can be a child of the control managed by this designer.</para> + </summary> + <param name="control"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Control" /> to test. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -122,9 +156,15 @@ </Parameters> <Docs> <param name="designer">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method indicates whether the control managed by this designer can parent the control of the specified <see cref="T:System.Windows.Forms.Design.ControlDesigner" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether the control managed by the specified designer can be a child of the control managed by this designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -141,9 +181,17 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The new component or control is positioned at the center of the currently selected control. This method uses the default size for the tool, if the tool has a default size specified.</para> + <para>To specify a location or location and size for the component or control, use one of the other overloaded <see cref="M:System.Windows.Forms.Design.ParentControlDesigner.CreateTool(System.Drawing.Design.ToolboxItem)" /> methods.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a component or control from the specified tool and adds it to the current design document.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to create a component from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -161,10 +209,19 @@ <Parameter Name="location" Type="System.Drawing.Point" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <param name="location">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The new component or control is positioned around the location specified by the <paramref name="location" /> parameter. This method uses the default size for the tool's component, if the component has a default size.</para> + <para>To specify a location and size for the component or control, use the appropriate overloaded <see cref="M:System.Windows.Forms.Design.ParentControlDesigner.CreateTool(System.Drawing.Design.ToolboxItem)" /> method.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a component or control from the specified tool and adds it to the current design document at the specified location.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to create a component from. </param> + <param name="location"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Point" />, in design-time view screen coordinates, at which to center the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -182,10 +239,18 @@ <Parameter Name="bounds" Type="System.Drawing.Rectangle" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <param name="bounds">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The new component or control is positioned with its upper left corner at the location specified by the <see cref="P:System.Drawing.Rectangle.X" /> and <see cref="P:System.Drawing.Rectangle.Y" /> values of the <paramref name="bounds" /> parameter. The size of the new component or control will be set to the values specified by the <see cref="P:System.Drawing.Rectangle.Height" /> and <see cref="P:System.Drawing.Rectangle.Width" /> properties of the <paramref name="bounds" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a component or control from the specified tool and adds it to the current design document within the bounds of the specified rectangle.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to create a component from. </param> + <param name="bounds"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Rectangle" /> indicating the location and size for the component created from the tool. The <see cref="P:System.Drawing.Rectangle.X" /> and <see cref="P:System.Drawing.Rectangle.Y" /> values of the <see cref="T:System.Drawing.Rectangle" /> indicate the design-time view screen coordinates of the upper-left corner of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -208,16 +273,29 @@ <Parameter Name="hasSize" Type="System.Boolean" /> </Parameters> <Docs> - <param name="tool">To be added.</param> - <param name="x">To be added.</param> - <param name="y">To be added.</param> - <param name="width">To be added.</param> - <param name="height">To be added.</param> - <param name="hasLocation">To be added.</param> - <param name="hasSize">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This is the only <see cref="Overload:System.Windows.Forms.Design.ParentControlDesigner.CreateTool" /> method that can be overridden.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides core functionality for all the <see cref="M:System.Windows.Forms.Design.ParentControlDesigner.CreateTool(System.Drawing.Design.ToolboxItem)" /> methods.</para> + </summary> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to create a component from. </param> + <param name="x"> + <attribution license="cc4" from="Microsoft" modified="false" />The horizontal position, in design-time view coordinates, of the location of the left edge of the tool, if a size is specified; the horizontal position of the center of the tool, if no size is specified. </param> + <param name="y"> + <attribution license="cc4" from="Microsoft" modified="false" />The vertical position, in design-time view coordinates, of the location of the top edge of the tool, if a size is specified; the vertical position of the center of the tool, if no size is specified. </param> + <param name="width"> + <attribution license="cc4" from="Microsoft" modified="false" />The width of the tool. This parameter is ignored if the <paramref name="hasSize" /> parameter is set to false. </param> + <param name="height"> + <attribution license="cc4" from="Microsoft" modified="false" />The height of the tool. This parameter is ignored if the <paramref name="hasSize" /> parameter is set to false. </param> + <param name="hasLocation"> + <attribution license="cc4" from="Microsoft" modified="false" />true if a location for the component is specified; false if the component is to be positioned in the center of the currently selected control. </param> + <param name="hasSize"> + <attribution license="cc4" from="Microsoft" modified="false" />true if a size for the component is specified; false if the default height and width values for the component are to be used. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -231,9 +309,15 @@ <ReturnType>System.Drawing.Point</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The default location is usually (0,0). The default location is typically changed if the container has special borders, or for other reasons.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the default location for a control added to the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -250,9 +334,17 @@ <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> - <param name="disposing">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para> + <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" /> references. This method invokes the Dispose() method of each referenced object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the unmanaged resources used by the <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" />, and optionally releases the managed resources.</para> + </summary> + <param name="disposing"> + <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -266,9 +358,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <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 a grid should be drawn on the control for this designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -282,9 +377,12 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether drag rectangles are drawn by the designer.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -301,10 +399,14 @@ <Parameter Name="component" Type="System.Object" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the control from the designer of the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component to retrieve the control for. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -324,10 +426,17 @@ <Parameter Name="selectionType" Type="System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> </Parameters> <Docs> - <param name="selectionType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <newTerm>body glyph</newTerm> is responsible for hit testing the control's designer and forwarding messages directly to the designer.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a body glyph that represents the bounds of the control. </para> + </summary> + <param name="selectionType"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> value that specifies the selection state.</param> </Docs> </Member> <Member MemberName="GetGlyphs"> @@ -343,10 +452,17 @@ <Parameter Name="selectionType" Type="System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> </Parameters> <Docs> - <param name="selectionType">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.ParentControlDesigner.GetGlyphs(System.Windows.Forms.Design.Behavior.GlyphSelectionType)" /> method adds a container selector <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> to the selection glyphs collection.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a collection of <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" /> objects representing the selection borders and grab handles for a standard control.</para> + </summary> + <param name="selectionType"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Design.Behavior.GlyphSelectionType" /> value that specifies the selection state.</param> </Docs> </Member> <Member MemberName="GetParentForComponent"> @@ -362,10 +478,14 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Used by deriving classes to determine if it returns the control being designed or some other <see cref="T:System.ComponentModel.Container" /> while adding a component to it.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The component for which to retrieve the parent <see cref="T:System.Windows.Forms.Control" />.</param> </Docs> </Member> <Member MemberName="GetUpdatedRect"> @@ -380,12 +500,21 @@ <Parameter Name="updateSize" Type="System.Boolean" /> </Parameters> <Docs> - <param name="originalRect">To be added.</param> - <param name="dragRect">To be added.</param> - <param name="updateSize">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method aligns the specified rectangle to the grid if grid alignment is enabled.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Updates the position of the specified rectangle, adjusting it for grid alignment if grid alignment mode is enabled.</para> + </summary> + <param name="originalRect"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Rectangle" /> indicating the initial position of the component being updated. </param> + <param name="dragRect"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Rectangle" /> indicating the new position of the component. </param> + <param name="updateSize"> + <attribution license="cc4" from="Microsoft" modified="false" />true to update the size of the rectangle, if there has been any change; otherwise, false. </param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -398,9 +527,12 @@ <ReturnType>System.Drawing.Size</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the size of each square of the grid that is drawn when the designer is in grid draw mode.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -417,9 +549,16 @@ <Parameter Name="component" Type="System.ComponentModel.IComponent" /> </Parameters> <Docs> - <param name="component">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called to initialize the designer with the specified primary component.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the designer with the specified component.</para> + </summary> + <param name="component"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to associate with the designer. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -439,9 +578,10 @@ <Parameter Name="defaultValues" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="defaultValues">To be added.</param> <summary>To be added.</summary> <remarks>To be added.</remarks> + <param name="defaultValues"> + <attribution license="cc4" from="Microsoft" modified="false" />A name/value dictionary of default values to apply to properties. May be null if no default values are specified.</param> </Docs> </Member> <Member MemberName="InvokeCreateTool"> @@ -455,10 +595,15 @@ <Parameter Name="tool" Type="System.Drawing.Design.ToolboxItem" /> </Parameters> <Docs> - <param name="toInvoke">To be added.</param> - <param name="tool">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Creates a tool from the specified <see cref="T:System.Drawing.Design.ToolboxItem" />.</para> + </summary> + <param name="toInvoke"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" /> that the tool is to be used with. </param> + <param name="tool"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Design.ToolboxItem" /> to create a tool from. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -475,9 +620,12 @@ <ReturnType>System.Drawing.Design.ToolboxItem</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the designer has a valid tool during a drag operation. </para> + </summary> </Docs> </Member> <Member MemberName="OnDragComplete"> @@ -493,9 +641,17 @@ <Parameter Name="de" Type="System.Windows.Forms.DragEventArgs" /> </Parameters> <Docs> - <param name="de">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="M:System.Windows.Forms.Design.ParentControlDesigner.OnDragComplete(System.Windows.Forms.DragEventArgs)" /> is used to clean up any operations that were performed at the beginning of a drag-and-drop operation.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called in order to clean up a drag-and-drop operation.</para> + </summary> + <param name="de"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DragEventArgs" /> that provides data for the event.</param> </Docs> </Member> <Member MemberName="OnDragDrop"> @@ -509,8 +665,14 @@ </Parameters> <Docs> <param name="e">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method checks any parent control for a drag-and-drop handler that can handle the operation instead. If one exists, this method passes the <see cref="T:System.Windows.Forms.DragEventArgs" /> to the method and returns. If no parent drag-and-drop handler exists, this method attempts to create a tool if a toolbox item has been dropped on the designer control.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when a drag-and-drop object is dropped onto the control designer view.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -528,8 +690,11 @@ </Parameters> <Docs> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when a drag-and-drop operation enters the control designer view.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -546,9 +711,13 @@ <Parameter Name="e" Type="System.EventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when a drag-and-drop operation leaves the control designer view.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -566,8 +735,11 @@ </Parameters> <Docs> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when a drag-and-drop object is dragged over the control designer view.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -585,10 +757,21 @@ <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> - <param name="x">To be added.</param> - <param name="y">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called in response to the left mouse button being pressed on a component. The designer overrides the base form of this method to provide a "lasso" selection mechanism for components within the control.</para> + <block subset="none" type="note"> + <para>You can pass a point in screen coordinates to the <see cref="M:System.Windows.Forms.Control.PointToClient(System.Drawing.Point)" /> method of the <see cref="T:System.Windows.Forms.Control" /> class to obtain the coordinates of the point relative to the upper-left corner of the control.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called in response to the left mouse button being pressed and held while over the component.</para> + </summary> + <param name="x"> + <attribution license="cc4" from="Microsoft" modified="false" />The x-coordinate of the mouse in screen coordinates. </param> + <param name="y"> + <attribution license="cc4" from="Microsoft" modified="false" />The y-coordinate of the mouse in screen coordinates. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -605,9 +788,16 @@ <Parameter Name="cancel" Type="System.Boolean" /> </Parameters> <Docs> - <param name="cancel">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called at the end of a drag operation. This method either commits to or cancels the drag operation.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called at the end of a drag-and-drop operation to complete or cancel the operation.</para> + </summary> + <param name="cancel"> + <attribution license="cc4" from="Microsoft" modified="false" />true to cancel the drag operation; false to commit it. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -625,10 +815,21 @@ <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> - <param name="x">To be added.</param> - <param name="y">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called at the start of a drag-and-drop operation.</para> + <block subset="none" type="note"> + <para>You can pass a point in screen coordinates to the <see cref="M:System.Windows.Forms.Control.PointToClient(System.Drawing.Point)" /> method of the <see cref="T:System.Windows.Forms.Control" /> class to obtain the coordinates of the point relative to the upper-left corner of the control.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called for each movement of the mouse during a drag-and-drop operation.</para> + </summary> + <param name="x"> + <attribution license="cc4" from="Microsoft" modified="false" />The x-coordinate of the mouse in screen coordinates. </param> + <param name="y"> + <attribution license="cc4" from="Microsoft" modified="false" />The y-coordinate of the mouse in screen coordinates. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -645,9 +846,13 @@ <Parameter Name="pe" Type="System.Windows.Forms.PaintEventArgs" /> </Parameters> <Docs> - <param name="pe">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Called when the control that the designer is managing has painted its surface so the designer can paint any additional adornments on top of the control.</para> + </summary> + <param name="pe"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.PaintEventArgs" /> that provides data for the event. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -662,8 +867,14 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method sets the mouse cursor according to the following rules: If the toolbox service has a tool selected, it allows the toolbox service to set the cursor. Otherwise, the mouse cursor is set to the default mouse cursor.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an opportunity to change the current mouse cursor.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -680,9 +891,16 @@ <Parameter Name="properties" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="properties">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This <see cref="T:System.ComponentModel.Design.IDesignerFilter" /> interface method override adds a set of properties to this designer's control that allow a user to set options related to the grid display and child control alignment. This method adds the following browsable properties: DrawGrid, SnapToGrid, and GridSize.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adjusts the set of properties the component will expose through a <see cref="T:System.ComponentModel.TypeDescriptor" />.</para> + </summary> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the properties for the class of the component. </param> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -699,10 +917,13 @@ <ReturnType>System.Collections.IList</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a list of <see cref="T:System.Windows.Forms.Design.Behavior.SnapLine" /> objects representing significant alignment points for this control. </para> + </summary> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ScrollableControlDesigner.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ScrollableControlDesigner.xml index f7d98d1df77..71ec4e5a177 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ScrollableControlDesigner.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ScrollableControlDesigner.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ScrollableControlDesigner" FullName="System.Windows.Forms.Design.ScrollableControlDesigner"> <TypeSignature Language="C#" Value="public class ScrollableControlDesigner : System.Windows.Forms.Design.ParentControlDesigner" /> <AssemblyInfo> @@ -10,8 +11,19 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:System.Windows.Forms.Design.ScrollableControlDesigner" /> provides a base class for designers of controls that respond to scroll messages. In addition to the methods and functionality inherited from the <see cref="T:System.Windows.Forms.Design.ParentControlDesigner" />, <see cref="T:System.Windows.Forms.Design.ControlDesigner" />, and <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> classes, <see cref="T:System.Windows.Forms.Design.ScrollableControlDesigner" /> provides a <see cref="M:System.Windows.Forms.Control.WndProc(System.Windows.Forms.Message@)" /> method override that passes WM_HSCROLL and WM_VSCROLL messages to the control at design time.</para> + <block subset="none" type="note"> + <para>If a form has its <see cref="P:System.Windows.Forms.Form.AutoScroll" /> property set to active, the scroll bars are always active in the design-time environment.</para> + </block> + <para>You can associate a designer with a type using a <see cref="T:System.ComponentModel.DesignerAttribute" />. For an overview of customizing design time behavior, see <format type="text/html"><a href="d6ac8a6a-42fd-4bc8-bf33-b212811297e2">Extending Design-Time Support</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Base designer class for extending the design mode behavior of a <see cref="T:System.Windows.Forms.Control" /> which should receive scroll messages.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,8 +31,11 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.ScrollableControlDesigner" /> class. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -38,9 +53,18 @@ </Parameters> <Docs> <param name="point">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="M:System.Windows.Forms.Design.ScrollableControlDesigner.GetHitTest(System.Drawing.Point)" /> method determines whether a click at the specified point should be passed to the control, while the control is in design mode. You can override and implement this method to enable your control to receive clicks in the design-time environment.</para> + <block subset="none" type="note"> + <para>You can pass a point in screen coordinates to the <see cref="M:System.Windows.Forms.Control.PointToClient(System.Drawing.Point)" /> method of the <see cref="T:System.Windows.Forms.Control" /> class to obtain the coordinates of the point relative to the upper-left corner of the control.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates whether a mouse click at the specified point should be handled by the control.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -67,4 +91,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/SelectionRules.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/SelectionRules.xml index 1bf2b3c6740..3f905fe2b63 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/SelectionRules.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/SelectionRules.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="SelectionRules" FullName="System.Windows.Forms.Design.SelectionRules"> <TypeSignature Language="C#" Value="public enum SelectionRules" /> <AssemblyInfo> @@ -14,8 +15,14 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>These identifiers indicate whether a component has some form of visible user interface and whether the user can take actions to move or alter the size of the component.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines identifiers that are used to indicate selection rules for a component.</para> + </summary> </Docs> <Members> <Member MemberName="AllSizeable"> @@ -25,7 +32,10 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates the component supports sizing in all directions.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -39,7 +49,10 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates the component supports resize from the bottom.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -53,7 +66,10 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates the component supports resize from the left.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -67,7 +83,10 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates the component is locked to its container. Overrides the <see cref="F:System.Windows.Forms.Design.SelectionRules.Moveable" />, <see cref="F:System.Windows.Forms.Design.SelectionRules.AllSizeable" />, <see cref="F:System.Windows.Forms.Design.SelectionRules.BottomSizeable" />, <see cref="F:System.Windows.Forms.Design.SelectionRules.LeftSizeable" />, <see cref="F:System.Windows.Forms.Design.SelectionRules.RightSizeable" />, and <see cref="F:System.Windows.Forms.Design.SelectionRules.TopSizeable" /> bit flags of this enumeration.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -81,7 +100,10 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates the component supports a location property that allows it to be moved on the screen.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -95,7 +117,10 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates no special selection attributes.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -109,7 +134,10 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates the component supports resize from the right.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -123,7 +151,10 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates the component supports resize from the top.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -137,7 +168,10 @@ <ReturnType>System.Windows.Forms.Design.SelectionRules</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Indicates the component has some form of visible user interface and the selection service is drawing a selection border around this user interface. If a selected component has this rule set, you can assume that the component implements <see cref="T:System.ComponentModel.IComponent" /> and that it is associated with a corresponding designer instance.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>1.0.5000.0</AssemblyVersion> @@ -145,4 +179,4 @@ </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ShortcutKeysEditor.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ShortcutKeysEditor.xml index cda0fb57a73..9693924c722 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ShortcutKeysEditor.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/ShortcutKeysEditor.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ShortcutKeysEditor" FullName="System.Windows.Forms.Design.ShortcutKeysEditor"> <TypeSignature Language="C#" Value="public class ShortcutKeysEditor : System.Drawing.Design.UITypeEditor" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides an editor for picking shortcut keys.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.ShortcutKeysEditor" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="EditValue"> @@ -40,12 +47,18 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <param name="provider">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Edits the given object value using the editor style provided by the <see cref="M:System.Windows.Forms.Design.ShortcutKeysEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information.</param> + <param name="provider"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.IServiceProvider" /> that this editor can use to obtain services.</param> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> to edit.</param> </Docs> </Member> <Member MemberName="GetEditStyle"> @@ -61,11 +74,18 @@ <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" /> </Parameters> <Docs> - <param name="context">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If the method is not supported, this method will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the editor style used by the <see cref="Overload:System.Windows.Forms.Design.ShortcutKeysEditor.EditValue" /> method.</para> + </summary> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that can be used to gain additional context information.</param> </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/WindowsFormsDesignerOptionService.xml b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/WindowsFormsDesignerOptionService.xml index 96078856db0..dd459b26cc3 100644 --- a/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/WindowsFormsDesignerOptionService.xml +++ b/mcs/class/System.Design/Documentation/en/System.Windows.Forms.Design/WindowsFormsDesignerOptionService.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="WindowsFormsDesignerOptionService" FullName="System.Windows.Forms.Design.WindowsFormsDesignerOptionService"> <TypeSignature Language="C#" Value="public class WindowsFormsDesignerOptionService : System.ComponentModel.Design.DesignerOptionService" /> <AssemblyInfo> @@ -9,8 +10,11 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides access to get and set option values for a Windows Forms designer.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -21,8 +25,11 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> <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.Design.WindowsFormsDesignerOptionService" /> class.</para> + </summary> </Docs> </Member> <Member MemberName="CompatibilityOptions"> @@ -35,9 +42,12 @@ <ReturnType>System.Windows.Forms.Design.DesignerOptions</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the <see cref="T:System.Windows.Forms.Design.DesignerOptions" /> exposed by the <see cref="T:System.Windows.Forms.Design.WindowsFormsDesignerOptionService" />.</para> + </summary> </Docs> </Member> <Member MemberName="PopulateOptionCollection"> @@ -59,4 +69,4 @@ </Docs> </Member> </Members> -</Type> +</Type>
\ No newline at end of file |