Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

XmlDataFileEditor Class

Provides a design-time user interface for selecting an XML data file.

Namespace:  System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)

[<SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
type XmlDataFileEditor =  
        inherit UrlEditor 

The XmlDataFileEditor type exposes the following members.

Public methodXmlDataFileEditorInitializes a new instance of the XmlDataFileEditor class.

Protected propertyCaptionGets the caption to display on the selection dialog box. (Overrides UrlEditor.Caption.)
Protected propertyFilterGets the URL filter options for the editor, which is used to filter the items that appear in the URL selection dialog box. (Overrides UrlEditor.Filter.)
Public propertyIsDropDownResizableGets a value indicating whether drop-down editors should be resizable by the user. (Inherited from UITypeEditor.)
Protected propertyOptionsGets the options for the URL builder to use. (Inherited from UrlEditor.)

Public methodEditValue(IServiceProvider, Object)Edits the value of the specified object using the editor style indicated by the GetEditStyle method. (Inherited from UITypeEditor.)
Public methodEditValue(ITypeDescriptorContext, IServiceProvider, Object)Edits the value of the specified object using the editor style provided by the GetEditStyle method. (Inherited from UrlEditor.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEditStyle()Gets the editor style used by the EditValue method. (Inherited from UITypeEditor.)
Public methodGetEditStyle(ITypeDescriptorContext)Gets the editing style of the EditValue method. (Inherited from UrlEditor.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetPaintValueSupported()Indicates whether this editor supports painting a representation of an object's value. (Inherited from UITypeEditor.)
Public methodGetPaintValueSupported(ITypeDescriptorContext)Indicates whether the specified context supports painting a representation of an object's value within the specified context. (Inherited from UITypeEditor.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPaintValue(PaintValueEventArgs)Paints a representation of the value of an object using the specified PaintValueEventArgs. (Inherited from UITypeEditor.)
Public methodPaintValue(Object, Graphics, Rectangle)Paints a representation of the value of the specified object to the specified canvas. (Inherited from UITypeEditor.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

An 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 XmlDataSource control uses the XmlDataFileEditor class at design time to set the value of the DataFile property.

Use the EditorAttribute attribute to associate the XmlDataFileEditor with a property. When the associated property is edited on the design surface, the designer host calls the EditValue method. The EditValue method uses the 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 GetEditStyle method indicates the display style of the user interface.

Derive a class from the XmlDataFileEditor to define a custom editor for an XML data property. For example, a derived class can override the EditValue method, and then call the BuildUrl method with a custom Filter or Caption value.

The following code example demonstrates how to associate an instance of the XmlDataFileEditor class with a property that is contained within a custom control. When the control property is edited on the design surface, the XmlDataFileEditor class provides the user interface to select and edit an XML file name for the property value.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft