89 lines
6.2 KiB
XML
89 lines
6.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="XmlDataFileEditor" FullName="System.Web.UI.Design.XmlDataFileEditor">
|
|
<TypeSignature Language="C#" Value="public class XmlDataFileEditor : System.Web.UI.Design.UrlEditor" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Design</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Web.UI.Design.UrlEditor</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> object is used at design time to select and edit a URL for an XML data file (.xml), and then assign the URL to a control property. For example, the <see cref="T:System.Web.UI.WebControls.XmlDataSource" /> control uses the <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> class at design time to set the value of the <see cref="P:System.Web.UI.WebControls.XmlDataSource.DataFile" /> property.</para>
|
|
<para>Use the <see cref="T:System.ComponentModel.EditorAttribute" /> attribute to associate the <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> with a property. When the associated property is edited on the design surface, the designer host calls the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method. The <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method uses the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The <see cref="Overload:System.Web.UI.Design.UrlEditor.GetEditStyle" /> method indicates the display style of the user interface.</para>
|
|
<para>Derive a class from the <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> to define a custom editor for an XML data property. For example, a derived class can override the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method, and then call the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method with a custom <see cref="P:System.Web.UI.Design.XmlDataFileEditor.Filter" /> or <see cref="P:System.Web.UI.Design.XmlDataFileEditor.Caption" /> value.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides a design-time user interface for selecting an XML data file.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public XmlDataFileEditor ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.XmlDataFileEditor" /> class. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Caption">
|
|
<MemberSignature Language="C#" Value="protected override string Caption { 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.XmlDataFileEditor.Caption" /> property is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the caption to display on the selection dialog box.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Filter">
|
|
<MemberSignature Language="C#" Value="protected override string Filter { 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.XmlDataFileEditor.Filter" /> property is used by the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method when calling the <see cref="Overload:System.Web.UI.Design.UrlBuilder.BuildUrl" /> method, which displays the URL selection dialog box to the user at design time.</para>
|
|
<para>The <see cref="P:System.Web.UI.Design.XmlDataFileEditor.Filter" /> property default value indicates two URL filters for the dialog box: one for XML data files (*.xml) and another for all files (*.*).</para>
|
|
<para>A filter string contains one or more filter options. Each filter option contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. </para>
|
|
<para>The following is an example of a filter string that contains two filter options: </para>
|
|
<para>"XML Files (*.xml)|*.xml|All Files (*.*)|*.*".</para>
|
|
<para>You can specify several filter patterns in a filter option by separating the filter patterns with semicolons. The following is an example of a filter string in which the first filter option specifies two filter patterns: </para>
|
|
<para>"Custom XML Files (*.xd1; *.xd2)|*.xd1;*.xd2|All Files (*.*)|*.*".</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the URL filter options for the editor, which is used to filter the items that appear in the URL selection dialog box.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |