mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
linux-packaging-mono/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/DesignerRegion.xml
Jo Shields a575963da9 Imported Upstream version 3.6.0 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

477 lines
22 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<Type Name="DesignerRegion" FullName="System.Web.UI.Design.DesignerRegion">
<TypeSignature Language="C#" Value="public class DesignerRegion : System.Web.UI.Design.DesignerObject" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.Design.DesignerObject</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.Design.DesignerRegion" /> object represents a region of content within the design-time markup that is generated by a <see cref="T:System.Web.UI.Design.ControlDesigner" /> implementation. A control developer uses designer regions in a custom <see cref="T:System.Web.UI.Design.ControlDesigner" /> implementation to define separate areas within the design-time markup for the associated control and to provide editing and event handling for the area. A visual designer, such as vsprvslong, can use designer regions to display the separate areas of a control on the design surface and to raise user events for the region to the control designer. Designer regions can simplify a control designer implementation because many region-based features are provided by the base designer classes and the visual designer.</para>
<para>The <see cref="T:System.Web.UI.Design.DesignerRegion" /> class provides the base functionality for designer regions, such as the ability to click, select, and highlight a region in the design surface. Use a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object in a control designer implementation to define a region that does not require editing. Use the derived <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> class in a control designer implementation to define a region with editable content at design time. Use the derived <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> class in a control designer implementation to define an editable region that represents a template in a control.</para>
<para>To support regions within a class that is derived from the <see cref="T:System.Web.UI.Design.ControlDesigner" />, override the <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method and add one or more initialized <see cref="T:System.Web.UI.Design.DesignerRegion" /> objects to the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> collection. Optionally, you can handle mouse clicks in the regions on the design surface by overriding the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method.</para>
<para>Use the properties of a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object to determine how the region is displayed by the visual designer. Override the <see cref="P:System.Web.UI.Design.DesignerRegion.Selectable" /> property to indicate that the region can be selected by the user on the design surface. Use the <see cref="P:System.Web.UI.Design.DesignerRegion.Highlight" /> property to highlight the designer region in the visual designer; for example, you can highlight a region after a user has clicked to select it. Use the <see cref="P:System.Web.UI.Design.DesignerRegion.DisplayName" /> and <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> properties to store or retrieve additional details about the region. In particular, the <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> property is used by the visual designer to display ToolTip information when the user moves the mouse pointer over the designer region. Use the <see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> property to access the methods and properties of the control designer object that contains the designer region.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines a region of content within the design-time markup for the associated control.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DesignerRegion (System.Web.UI.Design.ControlDesigner designer, string name);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="designer" Type="System.Web.UI.Design.ControlDesigner" />
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The following table shows the initial property values for an instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property</para>
</term>
<description>
<para>Initial Value</para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Description" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> </para>
</term>
<description>
<para>The input <paramref name="designer" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.DisplayName" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.EnsureSize" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Highlight" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Name" /> </para>
</term>
<description>
<para>The input <paramref name="name" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Properties" /> </para>
</term>
<description>
<para>An empty <see cref="T:System.Collections.Specialized.HybridDictionary" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Selectable" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Selected" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.UserData" />
</para>
</term>
<description>
<para>null.</para>
</description>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class with the specified name for a control designer.</para>
</summary>
<param name="designer">
<attribution license="cc4" from="Microsoft" modified="false" />The control designer that contains this designer region.</param>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of this designer region.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DesignerRegion (System.Web.UI.Design.ControlDesigner designer, string name, bool selectable);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="designer" Type="System.Web.UI.Design.ControlDesigner" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="selectable" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The following table shows the initial property values for an instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property</para>
</term>
<description>
<para>Initial Value</para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Description" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> </para>
</term>
<description>
<para>The input <paramref name="designer" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.DisplayName" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.EnsureSize" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Highlight" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Name" /> </para>
</term>
<description>
<para>The input <paramref name="name" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Properties" /> </para>
</term>
<description>
<para>An empty <see cref="T:System.Collections.Specialized.HybridDictionary" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Selectable" />
</para>
</term>
<description>
<para>The input <paramref name="selectable" /> value.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Selected" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.UserData" />
</para>
</term>
<description>
<para>null.</para>
</description>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class with the specified name for a control designer, optionally setting the instance as a selectable region in the designer.</para>
</summary>
<param name="designer">
<attribution license="cc4" from="Microsoft" modified="false" />The control designer that contains this designer region.</param>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of this designer region.</param>
<param name="selectable">
<attribution license="cc4" from="Microsoft" modified="false" />true to select the region; otherwise, false.</param>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public virtual string Description { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> property is used by the design host to display ToolTip information when the user moves the mouse pointer over the designer region.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the description for a designer region.</para>
</summary>
</Docs>
</Member>
<Member MemberName="DesignerRegionAttributeName">
<MemberSignature Language="C#" Value="public static readonly string DesignerRegionAttributeName = null;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<MemberValue>null</MemberValue>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The attribute name for a designer region is _designerRegion. The <see cref="F:System.Web.UI.Design.DesignerRegion.DesignerRegionAttributeName" /> field is used to identify regions within the design-time HTML markup for the control designer.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the HTML attribute name for a designer region.</para>
</summary>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C#" Value="public virtual string DisplayName { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the friendly display name for a designer region.</para>
</summary>
</Docs>
</Member>
<Member MemberName="EnsureSize">
<MemberSignature Language="C#" Value="public bool EnsureSize { set; 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>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the region size is to be explicitly set on the designer region by the design host.</para>
</summary>
</Docs>
</Member>
<Member MemberName="GetBounds">
<MemberSignature Language="C#" Value="public System.Drawing.Rectangle GetBounds ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Drawing.Rectangle</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.Design.DesignerRegion.GetBounds" /> method returns a value that is equivalent to calling the <see cref="M:System.Web.UI.Design.IControlDesignerView.GetBounds(System.Web.UI.Design.DesignerRegion)" /> method on the <see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> object with this designer region.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves the size of the designer region on the design surface.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Drawing.Rectangle" /> representing the designer region size on the design surface.</para>
</returns>
</Docs>
</Member>
<Member MemberName="Highlight">
<MemberSignature Language="C#" Value="public virtual bool Highlight { set; 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>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether to highlight the designer region on the design surface.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Selectable">
<MemberSignature Language="C#" Value="public virtual bool Selectable { set; 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>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the designer region can be selected by the user on the design surface.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Selected">
<MemberSignature Language="C#" Value="public virtual bool Selected { set; 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>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the designer region is currently selected on the design surface.</para>
</summary>
</Docs>
</Member>
<Member MemberName="UserData">
<MemberSignature Language="C#" Value="public object UserData { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Within a control designer implementation, use the <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> property to store or retrieve additional information for the designer region.</para>
<para>For example, if the control designer implementation supports selecting from multiple designer regions, you can use the <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> property in a control designer to store a unique index for each region. You can then use the <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> property for the region that is passed into the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method to store the index for the currently selected region.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets optional user data to associate with the designer region.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>
Reference in New Issue View Git Blame Copy Permalink