ITemplateEditingService.xml

<Type Name="ITemplateEditingService" FullName="System.Web.UI.Design.ITemplateEditingService">
  <TypeSignature Language="C#" Value="public interface ITemplateEditingService" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ITemplateEditingService" />
  <TypeSignature Language="DocId" Value="T:System.Web.UI.Design.ITemplateEditingService" />
  <TypeSignature Language="VB.NET" Value="Public Interface ITemplateEditingService" />
  <TypeSignature Language="F#" Value="type ITemplateEditingService = interface" />
  <TypeSignature Language="C++ CLI" Value="public interface class ITemplateEditingService" />
  <AssemblyInfo>
    <AssemblyName>System.Design</AssemblyName>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Attributes>
    <Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
      <AttributeName Language="C#">[System.Obsolete("Use of this type is not recommended because template editing is handled in ControlDesigner. To support template editing expose template data in the TemplateGroups property and call SetViewFlags(ViewFlags.TemplateEditing, true). http://go.microsoft.com/fwlink/?linkid=14202")]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Obsolete("Use of this type is not recommended because template editing is handled in ControlDesigner. To support template editing expose template data in the TemplateGroups property and call SetViewFlags(ViewFlags.TemplateEditing, true). http://go.microsoft.com/fwlink/?linkid=14202")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Provides services for editing control templates at design time.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
  
> [!NOTE]
>  The <xref:System.Web.UI.Design.ITemplateEditingService> interface is obsolete. Expose templates through the <xref:System.Web.UI.Design.ControlDesigner.TemplateGroups%2A> property of a control designer. The design host creates a <xref:System.Web.UI.Design.TemplatedEditableDesignerRegion> for each <xref:System.Web.UI.Design.TemplateGroup> defined for a control designer.  
  
 ]]></format>
    </remarks>
    <altmember cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" />
    <altmember cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" />
    <altmember cref="T:System.Web.UI.Design.TemplateGroup" />
  </Docs>
  <Members>
    <MemberGroup MemberName="CreateFrame">
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Docs>
        <summary>Creates a new template editing frame.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName="CreateFrame">
      <MemberSignature Language="C#" Value="public System.Web.UI.Design.ITemplateEditingFrame CreateFrame (System.Web.UI.Design.TemplatedControlDesigner designer, string frameName, string[] templateNames);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Web.UI.Design.ITemplateEditingFrame CreateFrame(class System.Web.UI.Design.TemplatedControlDesigner designer, string frameName, string[] templateNames) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.Design.ITemplateEditingService.CreateFrame(System.Web.UI.Design.TemplatedControlDesigner,System.String,System.String[])" />
      <MemberSignature Language="VB.NET" Value="Public Function CreateFrame (designer As TemplatedControlDesigner, frameName As String, templateNames As String()) As ITemplateEditingFrame" />
      <MemberSignature Language="F#" Value="abstract member CreateFrame : System.Web.UI.Design.TemplatedControlDesigner * string * string[] -&gt; System.Web.UI.Design.ITemplateEditingFrame" Usage="iTemplateEditingService.CreateFrame (designer, frameName, templateNames)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Web::UI::Design::ITemplateEditingFrame ^ CreateFrame(System::Web::UI::Design::TemplatedControlDesigner ^ designer, System::String ^ frameName, cli::array &lt;System::String ^&gt; ^ templateNames);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.UI.Design.ITemplateEditingFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="designer" Type="System.Web.UI.Design.TemplatedControlDesigner" />
        <Parameter Name="frameName" Type="System.String" />
        <Parameter Name="templateNames" Type="System.String[]" />
      </Parameters>
      <Docs>
        <param name="designer">The <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> that will use the template editing frame.</param>
        <param name="frameName">The name of the editing frame that will be displayed on the frame. Typically this is the same as the <see cref="P:System.ComponentModel.Design.DesignerVerb.Text" /> property used as the menu text for the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> that is invoked to create the frame.</param>
        <param name="templateNames">An array of names for the templates that the template editing frame will contain.</param>
        <summary>Creates a new template editing frame for the specified templated control designer, using the specified name and templates.</summary>
        <returns>The new <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" />.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
  
> [!NOTE]
>  The <xref:System.Web.UI.Design.ITemplateEditingService> interface is obsolete. Expose templates through the <xref:System.Web.UI.Design.ControlDesigner.TemplateGroups%2A> property of a control designer. The design host creates a <xref:System.Web.UI.Design.TemplatedEditableDesignerRegion> for each <xref:System.Web.UI.Design.TemplateGroup> defined for a control designer.  
  
 ]]></format>
        </remarks>
        <altmember cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" />
        <altmember cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" />
        <altmember cref="T:System.Web.UI.Design.TemplateGroup" />
      </Docs>
    </Member>
    <Member MemberName="CreateFrame">
      <MemberSignature Language="C#" Value="public System.Web.UI.Design.ITemplateEditingFrame CreateFrame (System.Web.UI.Design.TemplatedControlDesigner designer, string frameName, string[] templateNames, System.Web.UI.WebControls.Style controlStyle, System.Web.UI.WebControls.Style[] templateStyles);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Web.UI.Design.ITemplateEditingFrame CreateFrame(class System.Web.UI.Design.TemplatedControlDesigner designer, string frameName, string[] templateNames, class System.Web.UI.WebControls.Style controlStyle, class System.Web.UI.WebControls.Style[] templateStyles) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.Design.ITemplateEditingService.CreateFrame(System.Web.UI.Design.TemplatedControlDesigner,System.String,System.String[],System.Web.UI.WebControls.Style,System.Web.UI.WebControls.Style[])" />
      <MemberSignature Language="VB.NET" Value="Public Function CreateFrame (designer As TemplatedControlDesigner, frameName As String, templateNames As String(), controlStyle As Style, templateStyles As Style()) As ITemplateEditingFrame" />
      <MemberSignature Language="F#" Value="abstract member CreateFrame : System.Web.UI.Design.TemplatedControlDesigner * string * string[] * System.Web.UI.WebControls.Style * System.Web.UI.WebControls.Style[] -&gt; System.Web.UI.Design.ITemplateEditingFrame" Usage="iTemplateEditingService.CreateFrame (designer, frameName, templateNames, controlStyle, templateStyles)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Web::UI::Design::ITemplateEditingFrame ^ CreateFrame(System::Web::UI::Design::TemplatedControlDesigner ^ designer, System::String ^ frameName, cli::array &lt;System::String ^&gt; ^ templateNames, System::Web::UI::WebControls::Style ^ controlStyle, cli::array &lt;System::Web::UI::WebControls::Style ^&gt; ^ templateStyles);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.UI.Design.ITemplateEditingFrame</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="designer" Type="System.Web.UI.Design.TemplatedControlDesigner" />
        <Parameter Name="frameName" Type="System.String" />
        <Parameter Name="templateNames" Type="System.String[]" />
        <Parameter Name="controlStyle" Type="System.Web.UI.WebControls.Style" />
        <Parameter Name="templateStyles" Type="System.Web.UI.WebControls.Style[]" />
      </Parameters>
      <Docs>
        <param name="designer">The <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" /> that will use the template editing frame.</param>
        <param name="frameName">The name of the editing frame that will be displayed on the frame. Typically this is the same as the <see cref="P:System.ComponentModel.Design.DesignerVerb.Text" /> property used as the menu text for the <see cref="T:System.Web.UI.Design.TemplateEditingVerb" /> that is invoked to create the frame.</param>
        <param name="templateNames">An array of names for the templates that the template editing frame will contain.</param>
        <param name="controlStyle">The control <see cref="T:System.Web.UI.WebControls.Style" /> for the editing frame.</param>
        <param name="templateStyles">An array of type <see cref="T:System.Web.UI.WebControls.Style" /> that represents the template styles for the editing frame.</param>
        <summary>Creates a new template editing frame for the specified <see cref="T:System.Web.UI.Design.TemplatedControlDesigner" />, using the specified name, template names, control style, and template styles.</summary>
        <returns>The new <see cref="T:System.Web.UI.Design.ITemplateEditingFrame" />.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
  
> [!NOTE]
>  The <xref:System.Web.UI.Design.ITemplateEditingService> interface is obsolete. Expose templates through the <xref:System.Web.UI.Design.ControlDesigner.TemplateGroups%2A> property of a control designer. The design host creates a <xref:System.Web.UI.Design.TemplatedEditableDesignerRegion> for each <xref:System.Web.UI.Design.TemplateGroup> defined for a control designer.  
  
 ]]></format>
        </remarks>
        <altmember cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" />
        <altmember cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" />
        <altmember cref="T:System.Web.UI.Design.TemplateGroup" />
      </Docs>
    </Member>
    <Member MemberName="GetContainingTemplateName">
      <MemberSignature Language="C#" Value="public string GetContainingTemplateName (System.Web.UI.Control control);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetContainingTemplateName(class System.Web.UI.Control control) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.Design.ITemplateEditingService.GetContainingTemplateName(System.Web.UI.Control)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetContainingTemplateName (control As Control) As String" />
      <MemberSignature Language="F#" Value="abstract member GetContainingTemplateName : System.Web.UI.Control -&gt; string" Usage="iTemplateEditingService.GetContainingTemplateName control" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::String ^ GetContainingTemplateName(System::Web::UI::Control ^ control);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="control" Type="System.Web.UI.Control" />
      </Parameters>
      <Docs>
        <param name="control">The <see cref="T:System.Web.UI.Control" /> for which to get the name of the parent template.</param>
        <summary>Gets the name of the parent template.</summary>
        <returns>The name of the parent template.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
  
> [!NOTE]
>  The <xref:System.Web.UI.Design.ITemplateEditingService> interface is obsolete. Use the <xref:System.Web.UI.Design.TemplatedEditableDesignerRegion.TemplateDefinition%2A> property of the <xref:System.Web.UI.Design.TemplatedEditableDesignerRegion> class for equivalent design time functionality.  
  
 ]]></format>
        </remarks>
        <altmember cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" />
        <altmember cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" />
        <altmember cref="T:System.Web.UI.Design.TemplateGroup" />
      </Docs>
    </Member>
    <Member MemberName="SupportsNestedTemplateEditing">
      <MemberSignature Language="C#" Value="public bool SupportsNestedTemplateEditing { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool SupportsNestedTemplateEditing" />
      <MemberSignature Language="DocId" Value="P:System.Web.UI.Design.ITemplateEditingService.SupportsNestedTemplateEditing" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SupportsNestedTemplateEditing As Boolean" />
      <MemberSignature Language="F#" Value="member this.SupportsNestedTemplateEditing : bool" Usage="System.Web.UI.Design.ITemplateEditingService.SupportsNestedTemplateEditing" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property bool SupportsNestedTemplateEditing { bool get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a value that indicates whether the service supports nested template editing.</summary>
        <value>
          <see langword="true" /> if the service supports nested template editing; otherwise, <see langword="false" />.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This property indicates whether a template editor can be invoked from a component of a parent template editor's templated control. This is called nested template editing, because a template editor is invoked for a component of a control for which a template editor is already operating.  
  
> [!NOTE]
>  The <xref:System.Web.UI.Design.ITemplateEditingService> interface is obsolete. Expose templates through the <xref:System.Web.UI.Design.ControlDesigner.TemplateGroups%2A> property of a control designer. The design host creates a <xref:System.Web.UI.Design.TemplatedEditableDesignerRegion> for each <xref:System.Web.UI.Design.TemplateGroup> defined for a control designer.  
  
 ]]></format>
        </remarks>
        <altmember cref="P:System.Web.UI.Design.ControlDesigner.TemplateGroups" />
        <altmember cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" />
        <altmember cref="T:System.Web.UI.Design.TemplateGroup" />
      </Docs>
    </Member>
  </Members>
</Type>