mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 3.6.0

Browse Source 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
This commit is contained in:
Jo Shields
2014-08-13 10:39:27 +01:00
commit a575963da9
50588 changed files with 8155799 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/ConnectionConsumerCallback.xml Normal file
View File

@ -0,0 +1,22 @@
<Type Name="ConnectionConsumerCallback" FullName="System.Web.UI.WebControls.WebParts.ConnectionConsumerCallback">
<TypeSignature Language="C#" Value="public delegate void ConnectionConsumerCallback(object conn);" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="conn" Type="System.Object" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="conn">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
</Type>

200
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/ConnectionInterfaceCollection.xml Normal file
View File

@ -0,0 +1,200 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ConnectionInterfaceCollection" FullName="System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection">
<TypeSignature Language="C#" Value="public sealed class ConnectionInterfaceCollection : System.Collections.ReadOnlyCollectionBase" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Collections.ReadOnlyCollectionBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Communication between a provider and consumer requires a contract defined in an interface. This collection contains all the communication interfaces supported by the consumer. The <see cref="M:System.Web.UI.WebControls.WebParts.ProviderConnectionPoint.GetSecondaryInterfaces(System.Web.UI.Control)" /> method returns a <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection" /> object. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a collection of interfaces for use in Web Parts connections.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConnectionInterfaceCollection ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<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.WebControls.WebParts.ConnectionInterfaceCollection" /> class. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConnectionInterfaceCollection (System.Collections.ICollection connectionInterfaces);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="connectionInterfaces" Type="System.Collections.ICollection" />
</Parameters>
<Docs>
<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.WebControls.WebParts.ConnectionInterfaceCollection" /> class with the specified collection. </para>
</summary>
<param name="connectionInterfaces">
<attribution license="cc4" from="Microsoft" modified="false" />A collection of objects to convert into a <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConnectionInterfaceCollection (System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection existingConnectionInterfaces, System.Collections.ICollection connectionInterfaces);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="existingConnectionInterfaces" Type="System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection" />
<Parameter Name="connectionInterfaces" Type="System.Collections.ICollection" />
</Parameters>
<Docs>
<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.WebControls.WebParts.ConnectionInterfaceCollection" /> class by combining the two specified collections. </para>
</summary>
<param name="existingConnectionInterfaces">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection" /> to combine with the <paramref name="connectionInterfaces" /> object.</param>
<param name="connectionInterfaces">
<attribution license="cc4" from="Microsoft" modified="false" />A collection to combine with the <paramref name="existingConnectionInterfaces" /> object.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Contains">
<MemberSignature Language="C#" Value="public bool Contains (Type t);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="t" Type="System.Type" />
</Parameters>
<Docs>
<param name="t">To be added.</param>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection" /> object contains a specific value.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="value" /> is found in the <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection" />; otherwise, false.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CopyTo">
<MemberSignature Language="C#" Value="public void CopyTo (Type[] array, int index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="array" Type="System.Type[]" />
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Copies the entire <see cref="T:System.Collections.ReadOnlyCollectionBase" /> object to a compatible one-dimensional <see cref="T:System.Array" />, starting at the specified index of the target array.</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 elements copied from <see cref="T:System.Collections.ReadOnlyCollectionBase" />. 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>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Empty">
<MemberSignature Language="C#" Value="public static readonly System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection Empty;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection</ReturnType>
</ReturnValue>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>References a static, read-only instance of the <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IndexOf">
<MemberSignature Language="C#" Value="public int IndexOf (Type t);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="t" Type="System.Type" />
</Parameters>
<Docs>
<param name="t">To be added.</param>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Searches for the specified object and returns the zero-based index of the first occurrence within the entire <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection" /> collection. </para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The zero-based index of the first occurrence of <paramref name="value" /> within the entire <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionInterfaceCollection" />, if found; otherwise, -1.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public Type this[int index] { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

196
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/ConnectionPoint.xml Normal file
View File

@ -0,0 +1,196 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ConnectionPoint" FullName="System.Web.UI.WebControls.WebParts.ConnectionPoint">
<TypeSignature Language="C#" Value="public abstract class ConnectionPoint" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Every Web Parts connection consists of two server controls sharing data: one control is the consumer, the other is the provider. For a discussion of the essential components of a Web Parts connection, and the connection object itself, see the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartConnection" /> class overview. Every Web Parts connection requires connection points. The provider and the consumer control must each have at least one defined <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionPoint" /> object (each of them can optionally have multiple connection points) that contains the details for how a control can connect to another control and the type of data it can share. In an actual connection, the provider has its own type of connection point object (derived from the base <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionPoint" /> class), a <see cref="T:System.Web.UI.WebControls.WebParts.ProviderConnectionPoint" /> instance, and the consumer has its own object, a <see cref="T:System.Web.UI.WebControls.WebParts.ConsumerConnectionPoint" /> instance. </para>
<para>To create a provider connection point, developers must add a callback method to the provider that will return an implemented interface instance to a consumer. They must mark the callback method in the source code with a ConnectionProvider code attribute (see the <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionProviderAttribute" /> class). Similarly, to create a consumer connection point, developers must add a method to the consumer that receives an interface instance, and they must mark that method with a ConnectionConsumer attribute (see the <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionConsumerAttribute" /> class). </para>
<para>When developers create connections on a Web page, they can be created as static or dynamic connections. Static connections are declared in the markup of a Web page. When a static connection is declared, developers can designate which connection points are used for both the consumer and provider by assigning values to the ProviderConnectionPointID and ConsumerConnectionPointID attributes within the &lt;asp:webpartconnection&gt; element tag. This approach is especially useful if there are multiple connection points defined within the consumer and provider controls, because it enables the static connection to identify which connection points to use for the connection. </para>
<para>Dynamic connections are created programmatically, either by a developer's code or by users through the user interface (UI) provided by the <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionsZone" /> control. To create a connection in code, developers must get an instance of a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartConnection" /> object by calling the <see cref="M:System.Web.UI.WebControls.WebParts.WebPartManager.ConnectWebParts(System.Web.UI.WebControls.WebParts.WebPart,System.Web.UI.WebControls.WebParts.ProviderConnectionPoint,System.Web.UI.WebControls.WebParts.WebPart,System.Web.UI.WebControls.WebParts.ConsumerConnectionPoint)" /> method on the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" /> control. Before they can call this method, developers must have references to the consumer and provider server controls and their respective connection point objects. To get references to the connection points for a provider and a consumer control, developers first call the <see cref="M:System.Web.UI.WebControls.WebParts.WebPartManager.GetProviderConnectionPoints(System.Web.UI.WebControls.WebParts.WebPart)" /> and <see cref="M:System.Web.UI.WebControls.WebParts.WebPartManager.GetConsumerConnectionPoints(System.Web.UI.WebControls.WebParts.WebPart)" /> methods on the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" /> control. These methods return the appropriate connection point objects, which in turn can be passed to the method for creating a connection.</para>
<para>When the provider's and the consumer's connection point objects both work with the same type of interface, they are compatible and can form a direct connection to share data. If they do not work with the same interface type, a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> object must be used to translate the interface instance from the provider into a type that the consumer can work with. </para>
<para>The abstract <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionPoint" /> class provides the base details of connection points that are shared by both consumer and provider controls. Several properties contain these details. The <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.AllowsMultipleConnections" /> property indicates whether a connection point can participate in more than one connection at a time. By default, provider connection points can participate in multiple connections, and consumer connection points cannot. The <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.ControlType" /> property indicates the type of the server control associated with a connection point. Note that not only <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls can form connections; any server control, whether an ASP.NET control, a custom control, or a user control, can be enabled to participate in connections if placed in a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZoneBase" /> zone. The <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.DisplayName" /> property provides a friendly name for the connection point that can be displayed in the UI to assist users who are creating connections. The <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.ID" /> property serves as a string identifier for the connection point object itself. The <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.InterfaceType" /> property indicates what type of interface instance the connection point understands. Whether a given connection point provides or consumes an instance of that interface is determined by whether it is a <see cref="T:System.Web.UI.WebControls.WebParts.ProviderConnectionPoint" /> or a <see cref="T:System.Web.UI.WebControls.WebParts.ConsumerConnectionPoint" /> object. </para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionPoint" /> class has one method. The <see cref="M:System.Web.UI.WebControls.WebParts.ConnectionPoint.GetEnabled(System.Web.UI.Control)" /> method returns a Boolean value indicating whether a connection point is currently able to participate in connections. </para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionPoint" /> class also has one public field, <see cref="F:System.Web.UI.WebControls.WebParts.ConnectionPoint.DefaultID" />. This field contains a value used to identify the default connection point in a connection. </para>
<block subset="none" type="note">
<para>The attributes for specifying connection point methods have only one required parameter, <paramref name="displayName" />, so it is possible to create the default connection point attribute without specifying an ID. In such cases, the <see cref="F:System.Web.UI.WebControls.WebParts.ConnectionPoint.DefaultID" /> field supplies a base value to use.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Serves as the base class for defining connection point objects that enable the consumer control and the provider control in a Web Parts connection to share data.</para>
</summary>
</Docs>
<Members>
<Member MemberName="AllowsMultipleConnections">
<MemberSignature Language="C#" Value="public bool AllowsMultipleConnections { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Web.UI.WebControls.WebParts.ProviderConnectionPoint" /> objects have their <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.AllowsMultipleConnections" /> property value set to true (by the <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionProviderAttribute" /> class), because the Web Parts control set by default enables provider connection points to form connections to multiple consumers. </para>
<para>In contrast, <see cref="T:System.Web.UI.WebControls.WebParts.ConsumerConnectionPoint" /> objects have their <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.AllowsMultipleConnections" /> property value set to false (by the <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionConsumerAttribute" /> class) because the Web Parts control set by default allows consumer connection points to establish a connection to only one provider at a time. </para>
<para>You can change the default behavior concerning multiple connections by assigning different values to the <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionProviderAttribute.AllowsMultipleConnections" /> property (for providers) or the <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionConsumerAttribute.AllowsMultipleConnections" /> property (for consumers) on the two <see cref="T:System.Attribute" /> classes used for connection attributes. If you enable consumer connection points to connect to multiple providers at the same time, your code must deal with any resulting synchronization issues. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether a connection point supports multiple simultaneous connections.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ControlType">
<MemberSignature Language="C#" Value="public Type ControlType { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The value of the <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.ControlType" /> property is often the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> type. However, because any type of user control or server control can participate in connections if it is properly enabled and placed in a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZoneBase" /> zone, the <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.ControlType" /> property can return one of these other server control types as well. </para>
<para>When server controls that are not <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls are placed in a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZoneBase" /> zone, they are wrapped with a <see cref="T:System.Web.UI.WebControls.WebParts.GenericWebPart" /> object at run time so they can function as <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls and participate in connections. But when such controls are involved in connections, the <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.ControlType" /> property value does not return the <see cref="T:System.Web.UI.WebControls.WebParts.GenericWebPart" /> type; it returns the type of the <see cref="T:System.Web.UI.WebControls.WebParts.GenericWebPart" /> object's child control, which is the type of the server or user control. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the <see cref="T:System.Type" /> of the server control with which a connection point is associated.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DefaultID">
<MemberSignature Language="C#" Value="public const string DefaultID;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When a connection point is created, it is possible to specify an ID for the connection point in the source code of a consumer or provider <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control, using a <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionConsumerAttribute" /> or a <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionProviderAttribute" /> attribute. However, when an attribute is added to a connection point in the source code, the <paramref name="ID" /> parameter is optional. If the ID is not specified in the attribute, the <see cref="F:System.Web.UI.WebControls.WebParts.ConnectionPoint.DefaultID" /> field provides a string that is used to identify the default connection point.</para>
<para>If multiple connection points are defined in a consumer or provider control, it is necessary to specify an ID for each connection point, so that the connection points can be distinguished when creating connections.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a string used to identify the default connection point within a collection of connection points associated with a server control. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetEnabled">
<MemberSignature Language="C#" Value="public virtual bool GetEnabled (System.Web.UI.Control control);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="control" Type="System.Web.UI.Control" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.ConnectionPoint.GetEnabled(System.Web.UI.Control)" /> method in the base <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionPoint" /> class always returns true, but derived classes can override the method to return true or false at different times, based on the state of <paramref name="control" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a value that indicates whether a connection point can participate in connections. </para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the control can create a connection point to participate in a connection; otherwise, false.</para>
</returns>
<param name="control">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> or other server control that is associated with a connection point.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ID">
<MemberSignature Language="C#" Value="public string ID { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When a developer declares a <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionConsumerAttribute" /> or a <see cref="T:System.Web.UI.WebControls.WebParts.ConnectionProviderAttribute" /> attribute on a method in the source code of a control, so that the method can be used as a connection point, it is not required to declare the <paramref name="ID" /> parameter for the connection point attribute. The only required attribute is the <paramref name="displayName" /> parameter. A default ID is assigned to the connection point, using the value from the <see cref="F:System.Web.UI.WebControls.WebParts.ConnectionPoint.DefaultID" /> field. </para>
<para>If there is only one method in a control being used as a connection point, it is unnecessary to specify an ID for the connection point. If there are multiple methods specified as connection points, you must specify an ID for each one; otherwise, an exception will be thrown. By assigning an ID to each connection point, you also make it possible to specify which connection point to use when you declare connections in Web pages or create them in code.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a string that contains the identifier for a connection point.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InterfaceType">
<MemberSignature Language="C#" Value="public Type InterfaceType { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.InterfaceType" /> property indicates what type of interface a connection point uses. This can help to determine whether two controls are compatible and able to form a connection. If the provider connection point's <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.InterfaceType" /> is different from the consumer connection point's <see cref="P:System.Web.UI.WebControls.WebParts.ConnectionPoint.InterfaceType" />, then the two controls are incompatible (meaning that they cannot be directly connected without a transformer), and a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> object must be used to establish a connection.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the type of the interface used by a connection point.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<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" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

45
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/ConnectionPointType.xml Normal file
View File

@ -0,0 +1,45 @@
<Type Name="ConnectionPointType" FullName="System.Web.UI.WebControls.WebParts.ConnectionPointType">
<TypeSignature Language="C#" Value="public enum ConnectionPointType" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<Members>
<Member MemberName="Consumer">
<MemberSignature Language="C#" Value="Consumer" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WebParts.ConnectionPointType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Provider">
<MemberSignature Language="C#" Value="Provider" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WebParts.ConnectionPointType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

20
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/ConnectionProviderCallback.xml Normal file
View File

@ -0,0 +1,20 @@
<Type Name="ConnectionProviderCallback" FullName="System.Web.UI.WebControls.WebParts.ConnectionProviderCallback">
<TypeSignature Language="C#" Value="public delegate object ConnectionProviderCallback();" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters />
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
</Type>

133
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/ConsumerConnectionPoint.xml Normal file
View File

File diff suppressed because one or more lines are too long

296
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/EditorPart.xml Normal file
View File

@ -0,0 +1,296 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="EditorPart" FullName="System.Web.UI.WebControls.WebParts.EditorPart">
<TypeSignature Language="C#" Value="public abstract class EditorPart : System.Web.UI.WebControls.WebParts.Part" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.WebParts.Part</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.Designer("System.Web.UI.Design.WebControls.WebParts.EditorPartDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.IDesigner")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Bindable(false)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> class provides a base set of properties and methods that are used by the derived <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls provided with the Web Parts control set, and by custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls. An <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control allows a user to edit an associated <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control by modifying its layout, appearance, properties, behavior, or other characteristics. </para>
<para>The editing user interface (UI), which consists of <see cref="T:System.Web.UI.WebControls.WebParts.EditorZoneBase" /> zones that contain <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls, is displayed after a Web page enters edit mode. </para>
<block subset="none" type="note">
<para>An <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control can be used only within a zone that derives from the <see cref="T:System.Web.UI.WebControls.WebParts.EditorZoneBase" /> class, such as the <see cref="T:System.Web.UI.WebControls.WebParts.EditorZone" /> control.</para>
</block>
<para>After a page has entered edit mode, a user can select a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control to edit by clicking an edit verb on the verbs menu of the selected control. Only one <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control can be edited at a time. </para>
<para>Several derived <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls are provided with the Web Parts control set, as listed in the following table. These controls provide all the editing capabilities that are necessary for most applications. The typical approach for using these controls in a Web Parts page is to declare them in page persistence format within a &lt;zonetemplate&gt; element, where &lt;zonetemplate&gt; is the child element of an &lt;asp:editorzone&gt; element. For a code example, see the Example section of this topic.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Type of control</para>
</term>
<description>
<para>Description</para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="T:System.Web.UI.WebControls.WebParts.AppearanceEditorPart" /> </para>
</term>
<description>
<para>Edits the appearance of the associated control, including properties such as its title text, height, width, and border attributes.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="T:System.Web.UI.WebControls.WebParts.BehaviorEditorPart" /> </para>
</term>
<description>
<para>Edits certain behaviors of the associated control, such as whether it can be edited, whether it can be closed, or whether it can be moved to another zone. This control is only visible on a page when a control is being edited in shared personalization scope.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="T:System.Web.UI.WebControls.WebParts.LayoutEditorPart" /> </para>
</term>
<description>
<para>Edits layout attributes for the associated control, such as whether it is in a normal or minimized (collapsed) state, and what zone it is placed in. </para>
</description>
</item>
<item>
<term>
<para>
<see cref="T:System.Web.UI.WebControls.WebParts.PropertyGridEditorPart" /> </para>
</term>
<description>
<para>Edits properties of the associated control, if those properties were declared in the source code with a WebBrowsable attribute. </para>
</description>
</item>
</list>
<block subset="none" type="note">
<para>To improve accessibility, all the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls provided in the Web Parts control set are rendered within a &lt;fieldset&gt; element. The &lt;fieldset&gt; element groups the related set of controls used for editing in a given <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control, and it facilitates tabbed navigation among those controls for both visual user agents (such as ordinary Web browsers) and speech-oriented user agents (such as screen-reading software). </para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Serves as the base class for controls that reside in <see cref="T:System.Web.UI.WebControls.WebParts.EditorZoneBase" /> zones and are used to edit <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected EditorPart ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<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>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ApplyChanges">
<MemberSignature Language="C#" Value="public abstract bool ApplyChanges ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.ApplyChanges" /> method is a critical method on an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control. It is defined as an abstract method in the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> class, and must be implemented by inherited controls. The method's purpose is to save the values a user has entered into an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control to the corresponding properties in the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control that is referenced in the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.WebPartToEdit" /> property.</para>
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.ApplyChanges" /> method is called when the user clicks a button representing an OK or an apply verb in the editing user interface (UI). </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Saves the values in an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control to the corresponding properties in the associated <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the action of saving values from the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control to the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control is successful; otherwise (if an error occurs), false. </para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Display">
<MemberSignature Language="C#" Value="public virtual bool Display { get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>At certain points in the editing process, the zone that contains an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control checks the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.Display" /> property to determine whether to display the control. </para>
<para>There are two scenarios where the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.Display" /> property returns false and the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control is not displayed. The first scenario occurs when the control being edited is a <see cref="T:System.Web.UI.WebControls.WebParts.ProxyWebPart" /> control. The second scenario occurs when the control being edited has its <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.AllowEdit" /> and <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.IsShared" /> properties set to true, while the page's personalization scope is set at user level. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether a control should be displayed when its associated <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control is in edit mode.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DisplayTitle">
<MemberSignature Language="C#" Value="public string DisplayTitle { get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.DisplayTitle" /> property returns either the current value of the base <see cref="P:System.Web.UI.WebControls.WebParts.Part.Title" /> property or, if the control has no title, a calculated value. The calculated value consists of a localizable resource string for untitled controls. In the cases where no value is assigned to the <see cref="P:System.Web.UI.WebControls.WebParts.Part.Title" /> property, the value of the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.DisplayTitle" /> property differs from the <see cref="P:System.Web.UI.WebControls.WebParts.Part.Title" /> property.</para>
<para>Because the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.DisplayTitle" /> property is designed to be a read-only, calculated property to get the actual current value of the displayed title at run time, do not attempt to use this property to set a title for an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control. To set a title, use the base <see cref="P:System.Web.UI.WebControls.WebParts.Part.Title" /> property.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a string that contains the title text displayed in the title bar of an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetDesignModeState">
<MemberSignature Language="C#" Value="protected override System.Collections.IDictionary GetDesignModeState ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IDictionary</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.GetDesignModeState" /> method returns information about the state of the zone that contains an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control. The state information is returned in the form of a dictionary.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves the current state of an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control's parent zone.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Collections.IDictionary" /> that has the current state of the <see cref="T:System.Web.UI.WebControls.WebParts.EditorZoneBase" /> zone that contains an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="OnPreRender">
<MemberSignature Language="C#" Value="protected override void OnPreRender (EventArgs e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="e" Type="System.EventArgs" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>In addition to calling the base <see cref="M:System.Web.UI.Control.OnPreRender(System.EventArgs)" /> method, the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.OnPreRender(System.EventArgs)" /> method also checks the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.Display" /> property. If the value is false, meaning that the control should not be displayed, then the <see cref="P:System.Web.UI.Control.Visible" /> property is also set to false.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Raises the <see cref="E:System.Web.UI.Control.PreRender" /> 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="SyncChanges">
<MemberSignature Language="C#" Value="public abstract void SyncChanges ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.SyncChanges" /> method is a critical method on an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control. It is defined as an abstract method in the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> class, and must be implemented by inherited controls. The purpose of the method is to retrieve the current values from the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control referenced in the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.WebPartToEdit" /> property, and update the fields in the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control with those values so a user can edit them.</para>
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.SyncChanges" /> method is called whenever the values in the associated <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control might have changed. For every <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control, the <see cref="T:System.Web.UI.WebControls.WebParts.EditorZoneBase" /> zone that contains the control calls the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.SyncChanges" /> method immediately after calling the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.ApplyChanges" /> method, so that the values in the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control are always synchronized with the values in the associated <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control. Another case where the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.SyncChanges" /> method is called is when a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control is entering edit mode.</para>
<block subset="none" type="note">
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.SyncChanges" /> method is not called after the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.ApplyChanges" /> method if that method returns false, because in that case, an error has occurred. </para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves the property values from a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control for its associated <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="WebPartToEdit">
<MemberSignature Language="C#" Value="protected System.Web.UI.WebControls.WebParts.WebPart WebPartToEdit { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WebParts.WebPart</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control (or other server or user control) that is currently being edited corresponds to the value of the <see cref="P:System.Web.UI.WebControls.WebParts.WebPartManager.SelectedWebPart" /> property. Only one <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control can be edited at a time, and when a control is in edit mode, the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.WebPartToEdit" /> property provides a reference to that control. </para>
<para>After the <see cref="T:System.Web.UI.WebControls.WebParts.EditorZoneBase" /> zone has added the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control to its collection of controls, it then assigns the value of its own <see cref="P:System.Web.UI.WebControls.WebParts.EditorZoneBase.WebPartToEdit" /> property to the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.WebPartToEdit" /> property on the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control.</para>
<para>An <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control uses the <see cref="P:System.Web.UI.WebControls.WebParts.EditorPart.WebPartToEdit" /> property especially in its two critical methods--<see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.ApplyChanges" /> and <see cref="M:System.Web.UI.WebControls.WebParts.EditorPart.SyncChanges" />--to get and set the property values on the associated control.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a reference to the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control that is currently being edited. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

226
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/EditorPartCollection.xml Normal file
View File

@ -0,0 +1,226 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="EditorPartCollection" FullName="System.Web.UI.WebControls.WebParts.EditorPartCollection">
<TypeSignature Language="C#" Value="public sealed class EditorPartCollection : System.Collections.ReadOnlyCollectionBase" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Collections.ReadOnlyCollectionBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> class is a read-only collection of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls, typically used by an <see cref="T:System.Web.UI.WebControls.WebParts.EditorZoneBase" /> zone to track the set of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls contained by the zone.</para>
<para>When a Web Parts page enters edit mode, and a user selects a control to edit, the editing process begins. The zone creates a new <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> object consisting of the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls contained by the zone. At various phases in the editing process, the zone accesses the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> object to save or retrieve property values between the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls in the collection and the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control currently being edited. </para>
<para>You can create an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> collection of controls for your own programmatic use if, for example, you need to perform some mass operation on a set of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls. Even though the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> object is read-only, you can make programmatic changes to the properties of the underlying controls referenced in the collection.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Contains a collection of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls used for editing the properties, layout, appearance, and behavior of <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls. This class cannot be inherited. </para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EditorPartCollection ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.#ctor" /> constructor initializes an empty instance of the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> class. This overload of the constructor is used internally by the <see cref="T:System.Web.UI.WebControls.WebParts.EditorZone" /> class in its <see cref="M:System.Web.UI.WebControls.WebParts.EditorZone.CreateEditorParts" /> method to create an empty collection object. The zone then creates instances of all the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls declared in the child zone template, and uses an internal method to add them to the collection.</para>
<para>You cannot use this overload of the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.#ctor" /> constructor to create a new instance of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> and add <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls to it. You must use one of the other overloads for the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.#ctor" /> constructor instead.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes an empty new instance of the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EditorPartCollection (System.Collections.ICollection editorParts);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="editorParts" Type="System.Collections.ICollection" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.#ctor(System.Collections.ICollection)" /> constructor initializes an instance of the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> class and passes in a collection of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls. This is one overload of the <see cref="Overload:System.Web.UI.WebControls.WebParts.EditorPartCollection.#ctor" /> constructor that you can use to create a new <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> object and add <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls to it. </para>
<para>Even though the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> instance created by the constructor is read-only, you can still access the individual <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls in the collection programmatically and call their properties and methods.</para>
<para>One common scenario for using the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.#ctor(System.Collections.ICollection)" /> constructor would be if you want to perform some batch operation on an entire set of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls, such as changing the content, appearance, or position of a related group of them.</para>
<para>Another common scenario for using the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.#ctor(System.Collections.ICollection)" /> constructor is developing custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls that you want to associate with a server control, so that users can edit custom properties on your control. In this scenario, your server control must implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebEditable" /> interface, and as part of that task, it must implement the <see cref="M:System.Web.UI.WebControls.WebParts.IWebEditable.CreateEditorParts" /> method. In that method, to enable the custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls to edit your server control, you must add the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls to an <see cref="T:System.Collections.ICollection" /> instance, such as an <see cref="T:System.Collections.ArrayList" /> object. Then you can pass the collection of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls to the <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.#ctor(System.Web.UI.WebControls.WebParts.EditorPartCollection,System.Collections.ICollection)" /> constructor to create a new <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> object, which the <see cref="T:System.Web.UI.WebControls.WebParts.EditorZoneBase" /> zone uses to set up all the controls and begin the editing process.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> class by passing in an <see cref="T:System.Collections.ICollection" /> collection of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls.</para>
</summary>
<param name="editorParts">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ICollection" /> of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EditorPartCollection (System.Web.UI.WebControls.WebParts.EditorPartCollection existingEditorParts, System.Collections.ICollection editorParts);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="existingEditorParts" Type="System.Web.UI.WebControls.WebParts.EditorPartCollection" />
<Parameter Name="editorParts" Type="System.Collections.ICollection" />
</Parameters>
<Docs>
<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.WebControls.WebParts.EditorPartCollection" /> class by passing in an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> collection of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls, and an <see cref="T:System.Collections.ICollection" /> collection of additional <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls.</para>
</summary>
<param name="existingEditorParts">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ICollection" /> of existing <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls in a zone. </param>
<param name="editorParts">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ICollection" /> of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls not in a zone, but created programmatically. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Contains">
<MemberSignature Language="C#" Value="public bool Contains (System.Web.UI.WebControls.WebParts.EditorPart editorPart);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="editorPart" Type="System.Web.UI.WebControls.WebParts.EditorPart" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.Contains(System.Web.UI.WebControls.WebParts.EditorPart)" /> method determines whether a specific <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control is already in the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a value that indicates whether a particular control is in the collection.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A Boolean value that indicates whether the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> is in the collection.</para>
</returns>
<param name="editorPart">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> being tested for its status as a member of the collection. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CopyTo">
<MemberSignature Language="C#" Value="public void CopyTo (System.Web.UI.WebControls.WebParts.EditorPart[] array, int index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="array" Type="System.Web.UI.WebControls.WebParts.EditorPart[]" />
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.CopyTo(System.Web.UI.WebControls.WebParts.EditorPart[],System.Int32)" /> method is useful when you want to create a custom array that can contain the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls in the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> object, a subset of those controls, or a superset of those controls.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Copies the collection to an array of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls.</para>
</summary>
<param name="array">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> to contain the copied collection of controls. </param>
<param name="index">
<attribution license="cc4" from="Microsoft" modified="false" />The starting point in the array at which to place the collection contents. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Empty">
<MemberSignature Language="C#" Value="public static readonly System.Web.UI.WebControls.WebParts.EditorPartCollection Empty;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WebParts.EditorPartCollection</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A static, read-only, empty instance of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> reduces memory usage in cases where you want an empty collection instance to return the proper object type from a method or to compare the instance with another object, but you do not need to add members to the instance.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>References a static, read-only, empty instance of the collection. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IndexOf">
<MemberSignature Language="C#" Value="public int IndexOf (System.Web.UI.WebControls.WebParts.EditorPart editorPart);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="editorPart" Type="System.Web.UI.WebControls.WebParts.EditorPart" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.EditorPartCollection.IndexOf(System.Web.UI.WebControls.WebParts.EditorPart)" /> method is useful if you have multiple <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls on a Web Parts page, and you need to locate a particular control in the collection.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the position of a particular member of the collection.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An integer that corresponds to the index of an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control in the collection.</para>
</returns>
<param name="editorPart">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> that is a member of the collection. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public System.Web.UI.WebControls.WebParts.EditorPart this[int index] { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WebParts.EditorPart</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

30
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/FieldCallback.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="FieldCallback" FullName="System.Web.UI.WebControls.WebParts.FieldCallback">
<TypeSignature Language="C#" Value="public delegate void FieldCallback(object fieldValue);" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="fieldValue" Type="System.Object" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="fieldValue">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When a Web Parts control provides data through the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartField" /> interface, the consumer or transformer must retrieve and process the field data from the provider. The <see cref="T:System.Web.UI.WebControls.WebParts.FieldCallback" /> delegate represents the method to call for processing the provider data.</para>
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartField.GetFieldValue(System.Web.UI.WebControls.WebParts.FieldCallback)" /> method contains a <see cref="T:System.Web.UI.WebControls.WebParts.FieldCallback" /> delegate parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>References the method to call when retrieving field data from a provider.</para>
</summary>
</Docs>
</Type>

91
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IPersonalizable.xml Normal file
View File

@ -0,0 +1,91 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IPersonalizable" FullName="System.Web.UI.WebControls.WebParts.IPersonalizable">
<TypeSignature Language="C#" Value="public interface IPersonalizable" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>In addition to using the Personalizable attribute on control properties, a control can also implement <see cref="T:System.Web.UI.WebControls.WebParts.IPersonalizable" /> for additional management capabilities for the application and extraction of personalization state. For example, controls that need to manage private state information should implement this interface. Controls that access personalized data through complex mechanisms, such as custom cache solutions, data persistence to mainframes, or XML Web services, should also implement this interface.</para>
<block subset="none" type="note">
<para>You should not add types based on classes defined in the App_Code directory and then depend on the default binary serialization mechanism. App_Code-based artifacts are not consistently binary-serializable due to the fact that they can have their assembly names changed at random points in time.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines additional management capabilities for the application and extraction of personalization state. </para>
</summary>
</Docs>
<Members>
<Member MemberName="IsDirty">
<MemberSignature Language="C#" Value="public bool IsDirty { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When data managed by a control has changed, the control is considered "dirty." A control should return true if the custom data that it manages through the <see cref="T:System.Web.UI.WebControls.WebParts.IPersonalizable" /> interface has changed. If a control returns true from this property, the control's <see cref="M:System.Web.UI.WebControls.WebParts.IPersonalizable.Save(System.Web.UI.WebControls.WebParts.PersonalizationDictionary)" /> interface method implementation is called during property value extraction.</para>
<block subset="none" type="note">
<para>This property is checked automatically by the personalization infrastructure during the latter phases of processing a POST request. However, for GET requests, the value returned from the <see cref="P:System.Web.UI.WebControls.WebParts.IPersonalizable.IsDirty" /> property is not checked. Some other event has to have caused the control to be considered "dirty" for any control state--not just data managed by <see cref="T:System.Web.UI.WebControls.WebParts.IPersonalizable" />--to be saved. If a control can mark itself as "dirty" during a GET request, or if the personalization infrastructure under some very specific boundary conditions considers a control "dirty" during a GET request, then <see cref="M:System.Web.UI.WebControls.WebParts.IPersonalizable.Save(System.Web.UI.WebControls.WebParts.PersonalizationDictionary)" /> will always be called.</para>
</block>
<para>A control can reference its associated <see cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" /> control and check the <see cref="P:System.Web.UI.WebControls.WebParts.WebPartPersonalization.Scope" /> property to determine the current scope. The "dirty" state of a control's custom data should be appropriate for the current scope.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether the custom data that a control manages has changed. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Load">
<MemberSignature Language="C#" Value="public void Load (System.Collections.IDictionary sharedState, System.Collections.IDictionary userState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sharedState" Type="System.Collections.IDictionary" />
<Parameter Name="userState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<param name="sharedState">To be added.</param>
<param name="userState">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Save">
<MemberSignature Language="C#" Value="public void Save (System.Collections.IDictionary state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="state" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<param name="state">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

139
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/ITrackingPersonalizable.xml Normal file
View File

@ -0,0 +1,139 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ITrackingPersonalizable" FullName="System.Web.UI.WebControls.WebParts.ITrackingPersonalizable">
<TypeSignature Language="C#" Value="public interface ITrackingPersonalizable" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This interface allows control developers to track different phases of the personalization life cycle, including the loading and saving of personalization data. In most cases, to use this interface you would create a custom <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> or <see cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" /> and implement this interface. Additionally, controls that need to manage their own change ("dirty") tracking should implement this interface. Controls that manage their own change tracking should return true from the <see cref="P:System.Web.UI.WebControls.WebParts.ITrackingPersonalizable.TracksChanges" /> property.</para>
<para>If false is returned, then ASP.NET is responsible for determining changes by comparing the property information loaded with the property information that was saved.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Allows Web Parts controls to track the specific phases of the personalization load and save process.</para>
</summary>
</Docs>
<Members>
<Member MemberName="BeginLoad">
<MemberSignature Language="C#" Value="public void BeginLoad ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The Web Parts control set calls this method prior to applying personalization data. A control that tracks its own change state should use this method to set an internal flag indicating that properties should not call <see cref="Overload:System.Web.UI.WebControls.WebParts.WebPart.SetPersonalizationDirty" />. This is because property-setting methods can be called during the application of personalization data, subsequent to the call to <see cref="M:System.Web.UI.WebControls.WebParts.ITrackingPersonalizable.BeginLoad" />. In most scenarios, a control should not be considered changed ("dirty") just because its personalizable properties have been set based on data loaded from the underlying data store.</para>
<block subset="none" type="note">
<para>This method is also called when personalization data is applied after importing a Web Parts control.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the beginning of the load phase for personalization information. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BeginSave">
<MemberSignature Language="C#" Value="public void BeginSave ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The Web Parts control set calls this method prior to extracting personalization data from the control.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the phase prior to extracting personalization data from a control. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EndLoad">
<MemberSignature Language="C#" Value="public void EndLoad ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The Web Parts control set calls this method after personalization data has been applied to the control. A control that tracks its change state should use this method to reset its internal state to indicate that subsequent property-setting methods should call <see cref="Overload:System.Web.UI.WebControls.WebParts.WebPart.SetPersonalizationDirty" />. By the time the <see cref="M:System.Web.UI.WebControls.WebParts.ITrackingPersonalizable.EndLoad" /> method is called, the Web Parts control set has completed any application of personalization data to the control. As a result, subsequent changes to the control's state should be considered valid indicators that the control has changed (is "dirty").</para>
<block subset="none" type="note">
<para>This method is also called when personalization data is applied after importing a Web Parts control.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the phase after personalization data has been applied to a control. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EndSave">
<MemberSignature Language="C#" Value="public void EndSave ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The Web Parts control set calls this method after personalization data has been extracted from the control.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the phase after personalization data has been extracted from a control. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TracksChanges">
<MemberSignature Language="C#" Value="public bool TracksChanges { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If a control returns true from this property, then it is the Web Parts control's responsibility to determine when it considers itself "dirty." If a control determines that it has changed (is "dirty"), that control must call <see cref="Overload:System.Web.UI.WebControls.WebParts.WebPart.SetPersonalizationDirty" /> on itself.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the control tracks the status of its changes.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

65
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/ITransformerConfigurationControl.xml Normal file
View File

@ -0,0 +1,65 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ITransformerConfigurationControl" FullName="System.Web.UI.WebControls.WebParts.ITransformerConfigurationControl">
<TypeSignature Language="C#" Value="public interface ITransformerConfigurationControl" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A configuration control can be displayed when a transformer requires a user to configure it. The configuration control provides a user interface (UI) that allows the user to select which values will be transformed. It is rendered in a connections zone. The <see cref="M:System.Web.UI.WebControls.WebParts.WebPartTransformer.CreateConfigurationControl" /> method returns a configuration control.</para>
<para>You can override the <see cref="M:System.Web.UI.WebControls.WebParts.WebPartTransformer.CreateConfigurationControl" /> method when your transformer requires a customized UI. The configuration control must implement the <see cref="T:System.Web.UI.WebControls.WebParts.ITransformerConfigurationControl" /> interface, which includes the <see cref="E:System.Web.UI.WebControls.WebParts.ITransformerConfigurationControl.Cancelled" /> and <see cref="E:System.Web.UI.WebControls.WebParts.ITransformerConfigurationControl.Succeeded" /> events. These events occur when a transformer control was either not configured or configured successfully, respectively.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the contract a control implements to act as a configuration control for a transformer in a Web Parts connection.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Cancelled">
<MemberSignature Language="C#" Value="public event EventHandler Cancelled;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The Web Parts control that implements <see cref="T:System.Web.UI.WebControls.WebParts.ITransformerConfigurationControl" /> raises this event when a transformer configuration is not completed, either because the user canceled the configuration or because the configuration could not be performed.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Occurs when transformer configuration is not completed.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Succeeded">
<MemberSignature Language="C#" Value="public event EventHandler Succeeded;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The Web Parts control that implements <see cref="T:System.Web.UI.WebControls.WebParts.ITransformerConfigurationControl" /> raises this event when a transformer configuration is successfully completed.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Occurs when transformer configuration is successfully completed. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

54
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IVersioningPersonalizable.xml Normal file
View File

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IVersioningPersonalizable" FullName="System.Web.UI.WebControls.WebParts.IVersioningPersonalizable">
<TypeSignature Language="C#" Value="public interface IVersioningPersonalizable" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When you upgrade a Web Parts control to a newer version, there might be changes to the personalizable properties on the upgraded class. For example, an upgraded version of a Web Parts control might no longer support properties that were available in previous versions. In such a scenario, the Web Parts control set might load personalization data from the underlying data store, but have no properties against which to apply this data. If a control implements the <see cref="T:System.Web.UI.WebControls.WebParts.IVersioningPersonalizable" /> interface, the Web Parts control is passed the orphaned personalization data. The application can then use this data to update properties in the newer version, or use the data in some other manner. Note that if orphaned properties are detected when importing Web Parts controls, the <see cref="M:System.Web.UI.WebControls.WebParts.IVersioningPersonalizable.Load(System.Collections.IDictionary)" /> method is also called.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents an interface that can manage personalization data belonging to a previous version of a Web Parts control.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Load">
<MemberSignature Language="C#" Value="public void Load (System.Collections.IDictionary unknownProperties);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="unknownProperties" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="unknownProperties" /> parameter contains a merged representation of unknown personalization data, of both "User" and "Shared" scope, that could not be applied to the control. When a page is running in user scope, the unknown user-scope values are supplied (if available) rather than unknown shared-scope values. This information is stored as a series of name/value pairs where each name is the string name of a property that was not found on the control and each value contains the property value. It is the responsibility of the control to cast or convert the value to the appropriate type and carry out further processing (such as mapping data from an old property to a new property).</para>
<para>If a control's state changes, it should call <see cref="Overload:System.Web.UI.WebControls.WebParts.WebPart.SetPersonalizationDirty" /> (either the inherited method, or the public static method in the case of a control that does not derive from <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" />). If a control marks itself as "dirty", the Web Parts control set will extract personalization data from the control, regardless of the control's "dirty" state, and save it back to the underlying data store later in the personalization life cycle. A control should mark itself as "dirty" if, as a result of processing the values in the <paramref name="unknownProperties" /> parameter, the control's state has changed.</para>
<para>Note that if orphaned properties are detected when importing Web Parts controls, this method is automatically called.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Loads personalization data to a Web Parts control that does not have a corresponding personalized property for the data due to a version change.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the personalization data was successfully loaded; otherwise, false.</para>
</returns>
<param name="unknownProperties">
<attribution license="cc4" from="Microsoft" modified="false" />A dictionary of personalization data that could not be applied to a control.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

49
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IWebActionable.xml Normal file
View File

@ -0,0 +1,49 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IWebActionable" FullName="System.Web.UI.WebControls.WebParts.IWebActionable">
<TypeSignature Language="C#" Value="public interface IWebActionable" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A verb in <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls is an action that a user can carry out in the user interface (UI). Typically, a verb is represented in the UI by a clickable control such as a button, a link, or a menu item. The Web Parts control set provides standard verbs that are available by default to <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls and other server controls (such as custom, ASP.NET, and user controls) that can act like <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls when placed in <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZoneBase" /> zones. Standard verbs include close, minimize, restore, delete, edit, and export.</para>
<para>You can also create custom verbs for use with <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> and server controls. The <see cref="T:System.Web.UI.WebControls.WebParts.IWebActionable" /> interface, with its <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> property, gives you a way to integrate custom verbs into your controls. The <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class implements the <see cref="T:System.Web.UI.WebControls.WebParts.IWebActionable" /> interface and implements its single property. To add custom verbs to a control that inherits from the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class, you must override the <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.Verbs" /> property, add custom verbs to a collection, and return the collection. The collection referenced by the <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.Verbs" /> property contains only custom verbs; standard verbs are not included in this collection. The default return value of the <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.Verbs" /> property in a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control is null, because by default there are no custom verbs in the collection.</para>
<para>Adding custom verbs to server controls that are not <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls requires one extra step. In those cases, the controls must also implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebActionable" /> interface and implement the <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> property.</para>
<para>After you have added custom verbs to the <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> collection, the Web Parts control set automatically handles the other steps necessary to create and render the custom verbs.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Enables <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls or other server controls to contain collections of verbs.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Verbs">
<MemberSignature Language="C#" Value="public System.Web.UI.WebControls.WebParts.WebPartVerbCollection Verbs { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WebParts.WebPartVerbCollection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> property references a collection of custom verbs (if any) that are added to a verbs menu in the header of a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> or other server control. The <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> collection does not contain references to the standard <see cref="T:System.Web.UI.WebControls.WebParts.WebPartVerb" /> objects provided with the Web Parts control set, such as <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.CloseVerb" />, <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.DeleteVerb" />, <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.EditVerb" />, <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.RestoreVerb" />, or <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.MinimizeVerb" />.</para>
<para>Developers who want to add custom verbs to a custom control that derives from the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class can simply override the <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.Verbs" /> property that the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class implements.</para>
<para>Developers who want to add custom verbs to a user control, or a custom control that is not a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control, must implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebActionable" /> interface by providing an implementation of the <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> property. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a reference to a collection of custom <see cref="T:System.Web.UI.WebControls.WebParts.WebPartVerb" /> objects.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

77
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IWebEditable.xml Normal file
View File

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IWebEditable" FullName="System.Web.UI.WebControls.WebParts.IWebEditable">
<TypeSignature Language="C#" Value="public interface IWebEditable" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebEditable" /> interface enables you to associate custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls with a server control--such as a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control, a user control, or a custom server control. The <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls are contained with an <see cref="T:System.Web.UI.WebControls.WebParts.EditorZone" /> control, and this zone with its editing controls provides end users with a user interface (UI) for modifying properties, appearance, and behavior on the associated <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control. </para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebEditable" /> interface includes two exposed members. The <see cref="P:System.Web.UI.WebControls.WebParts.IWebEditable.WebBrowsableObject" /> property provides a way for <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls to get a reference to the associated server control. The <see cref="M:System.Web.UI.WebControls.WebParts.IWebEditable.CreateEditorParts" /> method is used to create an instance of each custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> control associated with a server control, and return them as a collection.</para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebEditable" /> interface is already implemented on the base <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class, although by default this implementation does not associate any custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls with the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class. To associate a derived <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control with custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls, you can override the <see cref="M:System.Web.UI.WebControls.WebParts.IWebEditable.CreateEditorParts" /> method. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides an interface for developers to specify custom editing controls that are associated with a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control.</para>
</summary>
</Docs>
<Members>
<Member MemberName="CreateEditorParts">
<MemberSignature Language="C#" Value="public System.Web.UI.WebControls.WebParts.EditorPartCollection CreateEditorParts ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WebParts.EditorPartCollection</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.IWebEditable.CreateEditorParts" /> method enables you to create a collection of all the custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls associated with your custom control, <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control, or user control, and return them as an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> object. The <see cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" /> control takes the collection and creates instances of all the <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls whenever the server control enters edit mode.</para>
<para>Typically you implement this method in a custom <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control by overriding its <see cref="M:System.Web.UI.WebControls.WebParts.WebPart.CreateEditorParts" /> method. In the method, you create instances of the custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls you want to associate with your controls, add them to an <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> object, and then return that object. The collection of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls is then assigned to the <see cref="P:System.Web.UI.WebControls.WebParts.EditorZoneBase.EditorParts" /> property of the <see cref="T:System.Web.UI.WebControls.WebParts.EditorZoneBase" /> zone. </para>
<block subset="none" type="note">
<para>Any <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> that is added to the collection of <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls in an implementation of the <see cref="M:System.Web.UI.WebControls.WebParts.IWebEditable.CreateEditorParts" /> method must have a value assigned to its ID property, otherwise an exception will be thrown when the collection is assigned to the <see cref="P:System.Web.UI.WebControls.WebParts.EditorZoneBase.EditorParts" /> property.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a collection of custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls associated with a server control that implements the <see cref="T:System.Web.UI.WebControls.WebParts.IWebEditable" /> interface.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Web.UI.WebControls.WebParts.EditorPartCollection" /> that contains the collection of custom <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls associated with a server control. </para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="WebBrowsableObject">
<MemberSignature Language="C#" Value="public object WebBrowsableObject { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.WebParts.IWebEditable.WebBrowsableObject" /> property provides a way for <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls to get a reference to the server controls they are associated with. </para>
<para>Although the property itself is read-only, the object reference that it returns enables <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls to change values in the server control.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a reference to the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control, user control, or custom control that will be edited by <see cref="T:System.Web.UI.WebControls.WebParts.EditorPart" /> controls.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

163
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IWebPart.xml Normal file
View File

@ -0,0 +1,163 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IWebPart" FullName="System.Web.UI.WebControls.WebParts.IWebPart">
<TypeSignature Language="C#" Value="public interface IWebPart" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> interface provides several UI-oriented properties that enhance the user experience of working with <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls. When you create controls that derive from the base <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class, you get an implementation of all the properties in the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> interface, because the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> base class implements this interface. </para>
<para>You can use existing user controls, ASP.NET controls, or custom server controls that do not inherit from the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class as part of a Web Parts application, and they can also use these UI-oriented properties declared by the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> interface. If you place existing server controls in a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZoneBase" /> zone, at run time they are wrapped with a <see cref="T:System.Web.UI.WebControls.WebParts.GenericWebPart" /> object. Because the <see cref="T:System.Web.UI.WebControls.WebParts.GenericWebPart" /> class inherits from the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> base class, it enables existing server controls to act as true <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls and it adds to them the properties of the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> interface.</para>
<para>If you place server controls that are not <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls in zones, they can use the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> properties at run time, and you can also declare values for those properties on server controls in the markup of the page (in page persistence format). However, because these properties are only available to the server controls at run time, design-time coding features such as IntelliSense do not recognize <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> properties that are declared on server controls. Declared properties on these controls still work when you load the page, but Microsoft Visual Studio does not recognize the properties as valid at design time. If you want to add the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> properties to existing server and user controls to enhance the design-time user experience, you can implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> interface in a server control. </para>
<para>Perhaps the main reason to implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> interface is for controls that do not support the use of expando (custom) properties. Expando properties are strings that can be added to a class dynamically as a property, by means of the <see cref="T:System.Web.UI.IAttributeAccessor" /> interface. Controls that implement this interface, including the <see cref="T:System.Web.UI.WebControls.WebControl" /> class and its children, can use expando properties. Therefore, all ASP.NET server controls, custom controls that derive from them, Web user controls, and <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls support the use of expando properties. But custom controls that inherit directly from the base <see cref="T:System.Web.UI.Control" /> class do not support expando properties. Thus, if you declare these controls within a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZone" />, you will not be able to declare the common <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> properties on the controls, properties such as <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.Title" /> and <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.Description" />. If you want to use these properties with such controls, you must implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines common user interface (UI) properties used by ASP.NET <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls. </para>
</summary>
</Docs>
<Members>
<Member MemberName="CatalogIconImageUrl">
<MemberSignature Language="C#" Value="public string CatalogIconImageUrl { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Web Parts applications often provide a catalog (or list) of controls that users can add to a page. The <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.CatalogIconImageUrl" /> property on a control contains the URL to an image that represents the control when it appears in a catalog.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the URL to an image that represents a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control in a catalog of controls.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.Description" /> property value is typically used as a descriptive string for a control in catalogs that provide lists of <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls, and as a ToolTip in a control's title bar. The content of the property appears in a ToolTip when a user positions the mouse pointer over the title text in a control's title bar.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a brief phrase that summarizes what a control does, for use in ToolTips and catalogs of <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Subtitle">
<MemberSignature Language="C#" Value="public string Subtitle { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.Subtitle" /> property is used to return a default subtitle string for a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control that is appended to the control's title in the title bar. </para>
<para>If you provide a default value for the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.Subtitle" /> property in a control that implements the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPart" /> interface, the Web Parts control set automatically appends it to the value of the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.Title" /> property of the control at run time. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a string that is concatenated with the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.Title" /> property value to form a complete title for a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Title">
<MemberSignature Language="C#" Value="public string Title { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The visible title text in a control's title bar is set by the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.Title" /> property.</para>
<para>If you do not supply a title for a control, the Web Parts control set automatically calculates a default string to use as a title. For more information, see <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.DisplayTitle" />. Also, it is possible to provide a default subtitle that is appended to the title string. For details, see <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.Subtitle" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the title of a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TitleIconImageUrl">
<MemberSignature Language="C#" Value="public string TitleIconImageUrl { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.TitleIconImageUrl" /> property provides a way to associate an icon with a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control. The icon appears in the control's own title bar. For thematic consistency, application developers might want to make this icon similar to the image that represents the control in a catalog of Web Parts controls (the image referenced in the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.CatalogIconImageUrl" /> property). </para>
<para>As it is implemented in the Web Parts control set, the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.TitleIconImageUrl" /> property can be personalized by end users to change the image or icon that appears in a control's title bar. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the URL to an image used to represent a Web Parts control in the control's own title bar.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TitleUrl">
<MemberSignature Language="C#" Value="public string TitleUrl { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When you assign a URL to the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.TitleUrl" /> property, the title of the control becomes a link. The purpose of this property is to provide a convenient way for end users to access additional information about a control. The additional information could provide copyright data, contact data, details about the creator of the control, or a summary of the control's purpose. </para>
<block subset="none" type="note">
<para>Normally, you would not use the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPart.TitleUrl" /> property to link to Help content. The best way to provide a link to Help for a control is to use the <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.HelpUrl" /> property. </para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a URL to supplemental information about a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

72
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IWebPartField.xml Normal file
View File

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IWebPartField" FullName="System.Web.UI.WebControls.WebParts.IWebPartField">
<TypeSignature Language="C#" Value="public interface IWebPartField" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This interface is designed to be used with Web Parts connections. In a Web Parts connection, two server controls that reside in a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZoneBase" /> zone establish a connection and share data, with one control acting as the consumer and the other control acting as a provider. The mechanism for sharing data in a Web Parts connection is an interface instance, which the provider serves to the consumer by means of a callback method. To establish a connection, the consumer and provider must both work with the same interface type for sharing data. If the consumer does not recognize the interface type sent by the provider, it is still possible to connect the controls by means of a transformer (a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> object) that translates the interface instance sent by the provider into a type that the consumer recognizes. For details on connections, see <see cref="T:System.Web.UI.WebControls.WebParts.WebPartConnection" /> and <format type="text/html"><a href="d98cfd0f-ebd6-4871-89d5-abbd2cdef67b">Web Parts Connections Overview</a></format>. </para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartField" /> interface is a provider interface included with the Web Parts control set as a standard interface for creating connections based on a data field. You can also create custom interfaces to use with Web Parts connections, but in many data-driven Web applications, it is useful to create connections based on a common row (for details, see the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartRow" /> interface), table (for details, see the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartTable" /> interface), or field from the data source, using the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartField" /> interface. In a typical connection, a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control acting as a provider would implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartField" /> interface and provide an instance of the interface to consumers in a special callback method. For example, the provider might implement an <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartField" /> interface for a field in your user information table that contains a Web user's postal code data. Another <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control acting as a consumer would define a special method to receive the interface instance, and could then extract the postal code data, and look up and display weather information based on the postal code. </para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartField" /> interface has two exposed members. The <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartField.Schema" /> property returns schema information about the data field encapsulated in a <see cref="T:System.ComponentModel.PropertyDescriptor" /> object. The <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartField.GetFieldValue(System.Web.UI.WebControls.WebParts.FieldCallback)" /> method declares a method that an implementer (such as a provider control) uses to retrieve the interface instance's field data when the callback method is invoked.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines a provider interface for connecting two server controls using a single field of data. </para>
</summary>
</Docs>
<Members>
<Member MemberName="GetFieldValue">
<MemberSignature Language="C#" Value="public void GetFieldValue (System.Web.UI.WebControls.WebParts.FieldCallback callback);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.Web.UI.WebControls.WebParts.FieldCallback" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to retrieve the data field values passed by the interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the value of the field that is being used by the interface as the basis of a connection between two <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls.</para>
</summary>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.WebParts.FieldCallback" /> delegate that contains the address of a method that receives the data.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Schema">
<MemberSignature Language="C#" Value="public System.ComponentModel.PropertyDescriptor Schema { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.ComponentModel.PropertyDescriptor</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This property provides property information for the data passed by the interface. Transformer and consumer controls can query this property to get information about the type, contents, and other details of the field contained in the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartField" /> interface instance sent by a provider.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the schema information for a data field that is used to share data between two <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

95
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IWebPartParameters.xml Normal file
View File

@ -0,0 +1,95 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IWebPartParameters" FullName="System.Web.UI.WebControls.WebParts.IWebPartParameters">
<TypeSignature Language="C#" Value="public interface IWebPartParameters" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Data is usually sent from a provider to a consumer in a Web Parts connection. However, in some cases, a provider needs a parameter from the consumer to determine which values it should send back. The <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartParameters" /> interface defines members to implement that facilitate the passing of a parameter from a consumer to a provider. </para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.RowToParametersTransformer" /> class implements the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartParameters" /> interface. Transformers are used to translate data between two Web Parts controls with incompatible connection points. A <see cref="T:System.Web.UI.WebControls.WebParts.RowToParametersTransformer" /> object transforms data from a provider implementing the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartRow" /> interface when the provider needs a parameter from the consumer.</para>
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartParameters.GetParametersData(System.Web.UI.WebControls.WebParts.ParametersCallback)" /> method retrieves the data from the provider and provides a callback method to process the data for the consumer. The callback method can be a customized method within the consumer that sets the return values accordingly.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the contract a Web Parts control implements to pass a parameter value in a Web Parts connection.</para>
</summary>
</Docs>
<Members>
<Member MemberName="GetParametersData">
<MemberSignature Language="C#" Value="public void GetParametersData (System.Web.UI.WebControls.WebParts.ParametersCallback callback);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.Web.UI.WebControls.WebParts.ParametersCallback" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartParameters.GetParametersData(System.Web.UI.WebControls.WebParts.ParametersCallback)" /> method is used to retrieve the values from the provider based on a parameter. The method represented by the <paramref name="callback" /> parameter processes the data for use by the consumer.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the value of the data from the connection provider.</para>
</summary>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />The method to call to process the data from the provider.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Schema">
<MemberSignature Language="C#" Value="public System.ComponentModel.PropertyDescriptorCollection Schema { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.ComponentModel.PropertyDescriptorCollection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartParameters.Schema" /> property provides property information for the data passed by the interface. Transformer and consumer controls can query this property to get information about the type, contents, and other details of the field contained in the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartParameters" /> interface instance.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the property descriptors for the data to be received by the consumer.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SetConsumerSchema">
<MemberSignature Language="C#" Value="public void SetConsumerSchema (System.ComponentModel.PropertyDescriptorCollection schema);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="schema" Type="System.ComponentModel.PropertyDescriptorCollection" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the property descriptors for the properties that the consumer receives when calling the <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartParameters.GetParametersData(System.Web.UI.WebControls.WebParts.ParametersCallback)" /> method.</para>
</summary>
<param name="schema">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> returned by <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartParameters.Schema" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

72
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IWebPartRow.xml Normal file
View File

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IWebPartRow" FullName="System.Web.UI.WebControls.WebParts.IWebPartRow">
<TypeSignature Language="C#" Value="public interface IWebPartRow" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This interface is designed to be used with Web Parts connections. In a Web Parts connection, two server controls that reside in a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZoneBase" /> zone establish a connection and share data, with one control acting as the consumer and the other control acting as a provider. The mechanism for sharing data in a Web Parts connection is an interface instance, which the provider serves to the consumer by means of a callback method. To establish a connection, the consumer and provider must both work with the same interface type for sharing data. If the consumer does not recognize the interface type sent by the provider, it is still possible to connect the controls by means of a transformer (a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> object) that translates the interface instance sent by the provider into a type that the consumer recognizes. For details on connections, see <see cref="T:System.Web.UI.WebControls.WebParts.WebPartConnection" /> and <format type="text/html"><a href="d98cfd0f-ebd6-4871-89d5-abbd2cdef67b">Web Parts Connections Overview</a></format>. </para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartRow" /> interface is a provider interface included with the Web Parts control set as a standard interface for creating connections based on a data row. You can also create custom interfaces to use with Web Parts connections, but in many data-driven Web applications, it is useful to create connections based on a common field (for details, see the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartField" /> interface), table (for details, see the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartTable" /> interface), or row from the data source. In a typical connection, a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control acting as a provider would implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartRow" /> interface and provide an instance of the interface to consumers in a special callback method. For example, the provider might implement an <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartRow" /> interface for a row that corresponds to a user in your user information table. Another <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control acting as a consumer would define a special method to receive the interface instance, and could then extract the user data, use it to look up additional information about that user's accounts, and display all the information related to that user on the page.</para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartRow" /> interface has two exposed members. The <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartRow.Schema" /> property returns schema information about the data row encapsulated in a <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> object. The <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartRow.GetRowData(System.Web.UI.WebControls.WebParts.RowCallback)" /> method declares a method that an implementer (such as a provider control) uses to retrieve the interface instance's row data when the callback method is invoked.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines a provider interface for connecting two server controls using a single field of data.</para>
</summary>
</Docs>
<Members>
<Member MemberName="GetRowData">
<MemberSignature Language="C#" Value="public void GetRowData (System.Web.UI.WebControls.WebParts.RowCallback callback);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.Web.UI.WebControls.WebParts.RowCallback" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to retrieve the data row values passed by the interface. The provider implements this method, and the consumer invokes it at the point when the consumer is ready to process or render data. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the data for the row that is being used by the interface as the basis of a connection between two <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls.</para>
</summary>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.WebParts.RowCallback" /> delegate that contains the address of a method that receives the data.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Schema">
<MemberSignature Language="C#" Value="public System.ComponentModel.PropertyDescriptorCollection Schema { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.ComponentModel.PropertyDescriptorCollection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This property provides property information for the data. Using the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartRow" /> interface in a connection, you get a <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> object, which is referenced by the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartRow.Schema" /> property. The contract specifies that calling Schema[n].GetValue(RowData) returns the value of the nth column in the row. You need to use the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartRow.Schema" /> property to get the values in the row.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the schema information for a data row that is used to share data between two <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

72
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IWebPartTable.xml Normal file
View File

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IWebPartTable" FullName="System.Web.UI.WebControls.WebParts.IWebPartTable">
<TypeSignature Language="C#" Value="public interface IWebPartTable" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This interface is designed to be used with Web Parts connections. In a Web Parts connection, two server controls that reside in a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZoneBase" /> zone establish a connection and share data, with one control acting as the consumer and the other control acting as a provider. The mechanism for sharing data in a Web Parts connection is an interface instance, which the provider serves to the consumer by means of a callback method. To establish a connection, the consumer and provider must both work with the same interface type for sharing data. If the consumer does not recognize the interface type sent by the provider, it is still possible to connect the controls by means of a transformer (a <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> object) that translates the interface instance sent by the provider into a type that the consumer recognizes. For details on connections, see <see cref="T:System.Web.UI.WebControls.WebParts.WebPartConnection" /> and <format type="text/html"><a href="d98cfd0f-ebd6-4871-89d5-abbd2cdef67b">Web Parts Connections Overview</a></format>. </para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartTable" /> interface is a provider interface included with the Web Parts control set as a standard interface for creating connections based on a data table. You can also create custom interfaces to use with Web Parts connections, but in many data-driven Web applications, it is useful to create connections based on a common field (for details, see the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartField" /> interface), row (for details, see the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartRow" /> interface), or table from the data source. In a typical connection, a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control acting as a provider would implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartTable" /> interface and provide an instance of the interface to consumers in a special callback method. For example, the provider might implement an <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartTable" /> interface for a table that contains financial performance data. Another <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control acting as a consumer would define a special method to receive the interface instance, and could then extract the data and render a chart to display the resulting information.</para>
<para>The <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartTable" /> interface has two exposed members. The <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartTable.Schema" /> property returns schema information about the data table encapsulated in a <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> object. The <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartTable.GetTableData(System.Web.UI.WebControls.WebParts.TableCallback)" /> method declares a method that an implementer (such as a provider control) uses to retrieve the interface instance's table data when the callback method is invoked.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines a provider interface for connecting two server controls using an entire table of data.</para>
</summary>
</Docs>
<Members>
<Member MemberName="GetTableData">
<MemberSignature Language="C#" Value="public void GetTableData (System.Web.UI.WebControls.WebParts.TableCallback callback);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.Web.UI.WebControls.WebParts.TableCallback" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to retrieve the data table values passed by the interface. The provider implements this method, and the consumer invokes it at the point when the consumer is ready to process or render data.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the data for the table that is being used by the interface as the basis of a connection between two <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls.</para>
</summary>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.WebParts.TableCallback" /> delegate that contains the address of a method that receives the data.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Schema">
<MemberSignature Language="C#" Value="public System.ComponentModel.PropertyDescriptorCollection Schema { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.ComponentModel.PropertyDescriptorCollection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This property provides property information on the data in an <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartTable" /> instance. There is an implicit contract between the schema referenced by the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartTable.Schema" /> property and the data in the table. The contract is that for each <see cref="T:System.ComponentModel.PropertyDescriptor" /> object in the <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartTable.Schema" /> property, you can call <see cref="M:System.ComponentModel.PropertyDescriptor.GetValue(System.Object)" /> on an element of the table data to get the value in a column or a row of the table. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the schema information for a data table that is used to share data between two <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

Some files were not shown because too many files have changed in this diff Show More