1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="WebFormsReferenceManager" FullName="System.Web.UI.Design.WebFormsReferenceManager">
<TypeSignature Language="C#" Value="public abstract class WebFormsReferenceManager" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> base class is implemented by designer hosts to provide access to types, directives, and user controls defined in a Web project document. A control designer class can use the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> to access the definitions in the current document, and to add a new tag prefix to the current document.</para>
<para>You access the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> services supplied by the designer host through the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.ReferenceManager" /> property of a <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> implementation. The <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> implementation can be accessed in two ways:</para>
<list type="bullet">
<item>
<para>Classes deriving from <see cref="T:System.Web.UI.Design.ControlDesigner" /> can use the <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> property to access a <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> implementation supplied by the designer host. The <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> implementation is supplied through the <see cref="P:System.Web.UI.Design.WebFormsRootDesigner.ReferenceManager" /> property of <see cref="P:System.Web.UI.Design.ControlDesigner.RootDesigner" /> property.</para>
</item>
<item>
<para>Other designer classes can access the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> implementation by first obtaining the <see cref="T:System.ComponentModel.Design.IDesignerHost" /> services implementation through the designer component's <see cref="P:System.ComponentModel.Component.Site" />, and then calling the <see cref="M:System.ComponentModel.Design.IDesignerHost.GetDesigner(System.ComponentModel.IComponent)" /> method using the designer host <see cref="P:System.ComponentModel.Design.IDesignerHost.RootComponent" /> property.</para>
<block subset="none" type="note">
<para>
<see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> replaces the obsolete interface <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" />. Older designer hosts may only support the <see cref="T:System.Web.UI.Design.IWebFormReferenceManager" /> interface implementation. Check that the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> and <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> implementations supplied by the designer host are not null to ensure the designer host implements the <see cref="T:System.Web.UI.Design.WebFormsRootDesigner" /> and <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> classes. </para>
</block>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a base class for accessing the types, directives, and controls in the current Web project document. This class must be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected WebFormsReferenceManager ();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Because the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class is abstract, you cannot create an instance of <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> directly using the constructor.</para>
<para>When deriving from the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class, override the constructor to implement custom initialization actions for your reference manager implementation.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebFormsReferenceManager" /> class. </para>
</summary>
</Docs>
</Member>
<Member MemberName="GetRegisterDirectives">
<MemberSignature Language="C#" Value="public abstract System.Collections.ICollection GetRegisterDirectives ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ICollection</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the register directives for the current project document.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A collection of strings representing the register directives defined in the current document.</para>
</returns>
</Docs>
</Member>
<Member MemberName="GetTagPrefix">
<MemberSignature Language="C#" Value="public abstract string GetTagPrefix (Type objectType);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="objectType" Type="System.Type" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the tag prefix for the specified object type.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The tag prefix for the specified object type, if found; otherwise, null.</para>
</returns>
<param name="objectType">
<attribution license="cc4" from="Microsoft" modified="false" />The type of the object.</param>
</Docs>
</Member>
<Member MemberName="GetType">
<MemberSignature Language="C#" Value="public abstract Type GetType (string tagPrefix, string tagName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tagPrefix" Type="System.String" />
<Parameter Name="tagName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the object type with the specified tag prefix and tag name.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Type" /> of the object with the specified tag prefix and name, if found; otherwise, null.</para>
</returns>
<param name="tagPrefix">
<attribution license="cc4" from="Microsoft" modified="false" />The tag prefix of the type to retrieve.</param>
<param name="tagName">
<attribution license="cc4" from="Microsoft" modified="false" />The tag name of the type to retrieve.</param>
</Docs>
</Member>
<Member MemberName="GetUserControlPath">
<MemberSignature Language="C#" Value="public abstract string GetUserControlPath (string tagPrefix, string tagName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tagPrefix" Type="System.String" />
<Parameter Name="tagName" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="M:System.Web.UI.Design.WebFormsReferenceManager.GetUserControlPath(System.String,System.String)" /> uses the tag prefix and name to locate the user control register directive in the current document, and returns the src attribute value defined in the register directive.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the relative URL path for the user control with the specified tag prefix and tag name.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A string representing the relative URL path for the specified user control, if found; otherwise, null.</para>
</returns>
<param name="tagPrefix">
<attribution license="cc4" from="Microsoft" modified="false" />The tag prefix of the user control to retrieve.</param>
<param name="tagName">
<attribution license="cc4" from="Microsoft" modified="false" />The tag name of the user control to retrieve.</param>
</Docs>
</Member>
<Member MemberName="RegisterTagPrefix">
<MemberSignature Language="C#" Value="public abstract string RegisterTagPrefix (Type objectType);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="objectType" Type="System.Type" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the tag prefix already exists, then a new register directive is not added.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds a tag prefix for the specified type.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The tag prefix string.</para>
</returns>
<param name="objectType">
<attribution license="cc4" from="Microsoft" modified="false" />The type to add a tag prefix for in the current document.</param>
</Docs>
</Member>
</Members>
</Type>
|