185 lines
15 KiB
XML
185 lines
15 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<Type Name="SupportsPreviewControlAttribute" FullName="System.Web.UI.Design.SupportsPreviewControlAttribute">
|
||
|
|
<TypeSignature Language="C#" Value="public sealed class SupportsPreviewControlAttribute : Attribute" />
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyName>System.Design</AssemblyName>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Base>
|
||
|
|
<BaseTypeName>System.Attribute</BaseTypeName>
|
||
|
|
</Base>
|
||
|
|
<Interfaces />
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.AttributeUsage(System.AttributeTargets.Class)</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Apply the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute to a control designer class to indicate the type of preview control that is supported by the control designer. Use this attribute to change a preview control for design-time rendering without affecting the actual persisted instance of the associated control.</para>
|
||
|
|
<para>Typically, you specify the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> when declaring a custom designer class that is derived from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class. The value of the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property for the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute determines the behavior for the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> and <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> members in the base <see cref="T:System.Web.UI.Design.ControlDesigner" /> class. </para>
|
||
|
|
<para>Set the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property to true to indicate that the designer uses a temporary copy of the associated control to generate the design-time HTML. Changes to the temporary control are not persisted. </para>
|
||
|
|
<para>Set the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property to false to indicate that the designer returns the control instance, specifically the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Component" /> property, from the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> method. Changes to the control object are persisted. </para>
|
||
|
|
<para>For example, the <see cref="T:System.Web.UI.Design.WebControls.CalendarDesigner" /> class is marked with the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> set to true. The designer uses the preview control with the automatic style formatting task, which allows the user to preview various autoformat styles that can be applied to the calendar. As the user selects different autoformat styles in the user interface, the selected style scheme is applied to the preview control. Applying a new style to the preview control does not change the scheme that is applied to the instance of the <see cref="T:System.Web.UI.WebControls.Calendar" /> control in the designer.</para>
|
||
|
|
<para>If the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> is not specified in the control designer declaration, the <see cref="T:System.Web.UI.Design.ControlDesigner" /> behavior is equivalent to specifying the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> as false.</para>
|
||
|
|
<block subset="none" type="note">
|
||
|
|
<para>Designer classes derived from the <see cref="T:System.Web.UI.Design.ControlDesigner" /> class can override the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> and <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> members, and ignore the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute. To determine the expected behavior for <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> and <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" />, see the reference documentation for the derived control designer class.</para>
|
||
|
|
</block>
|
||
|
|
<para>For general information about using attributes, see <format type="text/html"><a href="a4daf212-2410-423d-a800-7a08864e9bff">Attributes Overview</a></format> and <format type="text/html"><a href="30386922-1e00-4602-9ebf-526b271a8b87">Extending Metadata Using Attributes</a></format>. For more information about design-time attributes, see <format type="text/html"><a href="7aed9eb4-124b-4a15-a0a3-458f37ac9ef7">Attributes and Design-Time Support</a></format>.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Indicates whether a control designer requires a preview instance of the control at design time. This class cannot be inherited.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<Members>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="public SupportsPreviewControlAttribute (bool supportsPreviewControl);" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="supportsPreviewControl" Type="System.Boolean" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Typically, you do not need to create an instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class directly. Apply the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> to the class declaration of the custom control designer in the source code.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class and sets the initial value of the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="supportsPreviewControl">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The initial value to assign for <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" />.</param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Default">
|
||
|
|
<MemberSignature Language="C#" Value="public static readonly System.Web.UI.Design.SupportsPreviewControlAttribute Default;" />
|
||
|
|
<MemberType>Field</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Web.UI.Design.SupportsPreviewControlAttribute</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property of the <see cref="F:System.Web.UI.Design.SupportsPreviewControlAttribute.Default" /> field is set to false.</para>
|
||
|
|
<para>Use the <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.IsDefaultAttribute" /> method to determine whether the value for the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property is set to the default preview value.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets an instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class that is set to the default preview value. This field is read-only.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Equals">
|
||
|
|
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="obj" Type="System.Object" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.Equals(System.Object)" /> method overrides the <see cref="M:System.Object.Equals(System.Object)" /> method.</para>
|
||
|
|
<para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.Equals(System.Object)" /> method compares two instances based on the value of their <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> properties.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Determines whether the specified object represents the same preview attribute setting as the current instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>true if <paramref name="obj" /> is a <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute and its value is the same as this instance of <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" />; otherwise, false.</para>
|
||
|
|
</returns>
|
||
|
|
<param name="obj">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The object to compare with the current instance of <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" />.</param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="GetHashCode">
|
||
|
|
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Int32</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.GetHashCode" /> method overrides the <see cref="M:System.Object.GetHashCode" /> method.</para>
|
||
|
|
<para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.GetHashCode" /> method generates the same hash code for two objects that are equal according to the <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.Equals(System.Object)" /> method. The hash code is suitable for use in hashing algorithms and data structures, such as hash tables.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Returns the hash code for this instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>A 32-bit signed integer hash code for the current instance of <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" />.</para>
|
||
|
|
</returns>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="IsDefaultAttribute">
|
||
|
|
<MemberSignature Language="C#" Value="public override bool IsDefaultAttribute ();" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="M:System.Web.UI.Design.SupportsPreviewControlAttribute.IsDefaultAttribute" /> method compares the value for the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property of the current <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> object with the value for the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property of the static <see cref="F:System.Web.UI.Design.SupportsPreviewControlAttribute.Default" /> field.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Indicates whether the current instance of the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> class is set to the default preview attribute value.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>true if the current instance of <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> is equal to the default preview attribute value; otherwise, false.</para>
|
||
|
|
</returns>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="SupportsPreviewControl">
|
||
|
|
<MemberSignature Language="C#" Value="public bool SupportsPreviewControl { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Typically, you specify a value for the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property by applying the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute to a custom designer class declaration. The value of the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property for the <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> attribute determines the behavior for the <see cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" /> and <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> members in the base <see cref="T:System.Web.UI.Design.ControlDesigner" /> class.</para>
|
||
|
|
<para>Set the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property to true to indicate that the designer uses a temporary copy of the associated control to generate the design-time HTML. Changes to the temporary control are not persisted. </para>
|
||
|
|
<para>Set the <see cref="P:System.Web.UI.Design.SupportsPreviewControlAttribute.SupportsPreviewControl" /> property to false to indicate that the designer returns the control instance, specifically the <see cref="P:System.ComponentModel.Design.ComponentDesigner.Component" /> property, from the <see cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" /> method. Changes to the control object are persisted.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets a value indicating whether the control designer requires a temporary preview control at design time.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
</Members>
|
||
|
|
</Type>
|