linux-packaging-mono/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/TemplateEditingVerb.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="TemplateEditingVerb" FullName="System.Web.UI.Design.TemplateEditingVerb">
  <TypeSignature Language="C#" Value="public class TemplateEditingVerb : System.ComponentModel.Design.DesignerVerb, IDisposable" />
  <AssemblyInfo>
    <AssemblyName>System.Design</AssemblyName>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ComponentModel.Design.DesignerVerb</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <block subset="none" type="note">
        <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para>
      </block>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Represents a designer verb that creates a template editing frame, and that can be invoked only by a template editor.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public TemplateEditingVerb (string text, int index);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="text" Type="System.String" />
        <Parameter Name="index" Type="System.Int32" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <block subset="none" type="note">
            <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class with the specified verb text and index.</para>
        </summary>
        <param name="text">
          <attribution license="cc4" from="Microsoft" modified="false" />The text to show for the verb on a menu.</param>
        <param name="index">
          <attribution license="cc4" from="Microsoft" modified="false" />An optional integer value that can be used by a designer, typically to indicate the index of the verb within a set of verbs.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public TemplateEditingVerb (string text, int index, System.Web.UI.Design.TemplatedControlDesigner designer);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="text" Type="System.String" />
        <Parameter Name="index" Type="System.Int32" />
        <Parameter Name="designer" Type="System.Web.UI.Design.TemplatedControlDesigner" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <block subset="none" type="note">
            <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class.</para>
        </summary>
        <param name="text">
          <attribution license="cc4" from="Microsoft" modified="false" />The text to show for the verb on a menu. </param>
        <param name="index">
          <attribution license="cc4" from="Microsoft" modified="false" />An optional integer value that can be used by a designer, typically to indicate the index of the verb within a set of verbs. </param>
        <param name="designer">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> that can use this verb. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Calling <see cref="M:System.Web.UI.Design.TemplateEditingVerb.Dispose" /> allows the resources used by the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> to be reallocated for other purposes. </para>
          <block subset="none" type="note">
            <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Releases all resources used by the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" />.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="disposing" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This method is called by the public Dispose method and the <see cref="M:System.Object.Finalize" /> method. Dispose invokes the protected Dispose(Boolean) method with <paramref name="disposing" /> set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para>
          <para>When <paramref name="disposing" /> is true, this method releases all resources held by any managed objects that this <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> references. This method invokes the Dispose method of each referenced object.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Releases the unmanaged resources used by the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> and optionally releases the managed resources.</para>
        </summary>
        <param name="disposing">
          <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Finalize">
      <MemberSignature Language="C#" Value="~TemplateEditingVerb ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This method overrides <see cref="M:System.Object.Finalize" /> and cleans up resources by calling Dispose(false). Override Dispose(Boolean) to customize the cleanup.</para>
          <para>Application code should not call this method; an object's Finalize method is automatically invoked during garbage collection, unless finalization by the garbage collector has been disabled by a call to the <see cref="M:System.GC.SuppressFinalize(System.Object)" /> method.</para>
          <para>For more information, see <format type="text/html"><a href="FD376774-1643-499B-869E-9546A3AEEA70">[&lt;topic://cpconFinalizeMethodscDestructors&gt;]</a></format>, <format type="text/html"><a href="a17b0066-71c2-4ba4-9822-8e19332fc213">Cleaning Up Unmanaged Resources</a></format>, and <format type="text/html"><a href="8026CB68-FE93-43FC-96C1-C09AD7D64CD3">[&lt;topic://cpconOverridingFinalizeMethod&gt;]</a></format>.</para>
          <block subset="none" type="note">
            <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Attempts to free resources before the object is reclaimed by garbage collection.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Index">
      <MemberSignature Language="C#" Value="public int Index { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This property is sometimes used to store the index of each verb in a set of verbs. When implementing a custom designer, this property can be used to store custom-defined integer data.</para>
          <block subset="none" type="note">
            <para>The <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> class is obsolete. Expose templates through the <see cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" /> property of a control designer. The design host creates a <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> for each <see cref="T:System.Web.UI.Design.TemplateGroup" /> defined for a control designer.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the index or other user data for the verb.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
  <Attributes>
    <Attribute>
      <AttributeName>System.Obsolete("Template editing is supported in ControlDesigner.TemplateGroups with SetViewFlags(ViewFlags.TemplateEditing, true) in 2.0.")</AttributeName>
    </Attribute>
  </Attributes>
</Type>