DataGridDesigner 类

定义

命名空间:

System.Web.UI.Design.WebControls

程序集:

System.Design.dll

扩展 DataGrid Web 服务器控件的设计时行为。

public ref class DataGridDesigner : System::Web::UI::Design::WebControls::BaseDataListDesigner

[System.Web.UI.Design.SupportsPreviewControl(true)]
public class DataGridDesigner : System.Web.UI.Design.WebControls.BaseDataListDesigner

[<System.Web.UI.Design.SupportsPreviewControl(true)>]
type DataGridDesigner = class
    inherit BaseDataListDesigner

Public Class DataGridDesigner
Inherits BaseDataListDesigner

继承

Object

ComponentDesigner

HtmlControlDesigner

ControlDesigner

TemplatedControlDesigner

BaseDataListDesigner

DataGridDesigner

属性

SupportsPreviewControlAttribute

示例

下面的代码示例演示如何扩展 DataGridDesigner 类。 当控件呈现在CellPadding设计图面上时DataGrid，代码将重写 GetDesignTimeHtml 方法来自定义 、 BorderWidth和 BorderColor 属性。

Imports System.Diagnostics
Imports System.ComponentModel
Imports System.Drawing
Imports System.Web.UI.Design.WebControls
Imports System.Web.UI.WebControls

Namespace Examples.AspNet

    ' Create a designer class for the SimpleDataList class.
    <System.Security.Permissions.SecurityPermission( _
    System.Security.Permissions.SecurityAction.Demand, _
    Flags:=System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode)> _
    Public Class SimpleDataListDesigner
        Inherits DataListDesigner

        Private simpleList As SimpleDataList


        ' Override the GetDesignTimeHtml method to add style to the control
        ' on the design surface.
        Public Overrides Function GetDesignTimeHtml() As String
            ' Cast the control to the Component property of the designer.
            simpleList = CType(Component, SimpleDataList)

            Dim designTimeHtml As String = Nothing

            ' Create variables to hold current property values.
            Dim oldBorderWidth As Unit = simpleList.BorderWidth
            Dim oldBorderColor As Color = simpleList.BorderColor

            ' Set the properties and generate the design-time HTML.
            If (simpleList.Enabled) Then
                Try
                    simpleList.BorderWidth = Unit.Point(5)
                    simpleList.BorderColor = Color.Purple
                    designTimeHtml = MyBase.GetDesignTimeHtml()

                    ' Call the GetErrorDesignTimeHtml method if an
                    ' exception occurs.
                Catch ex As Exception
                    designTimeHtml = GetErrorDesignTimeHtml(ex)

                    ' Return the properties to their original settings.
                Finally
                    simpleList.BorderWidth = oldBorderWidth
                    simpleList.BorderColor = oldBorderColor
                End Try
                ' If the list is not enabled, call the GetEmptyDesignTimeHtml
                ' method.
            Else
                designTimeHtml = GetEmptyDesignTimeHtml()
            End If

            Return designTimeHtml

        End Function

        Protected Overrides Function GetEmptyDesignTimeHtml() As String
            Dim emptyText As String

            ' Check the CanEnterTemplateMode property to
            ' specify which text to display if ItemTemplate 
            ' does not contain a value.
            If CanEnterTemplateMode Then
                emptyText = _
                    "<b>Either the Enabled property value is false " + _
                    "or you need to set the ItemTemplate for this " + _
                    "control.<br>Right-click to edit templates.</b>"
            Else
                emptyText = _
                    "<b>You cannot edit templates in this view.<br>" + _
                    "Switch to HTML view to define the ItemTemplate.</b>"
            End If

            Return CreatePlaceHolderDesignTimeHtml(emptyText)
        End Function

        ' Generate HTML to indicate that an error has occurred.
        Protected Overrides Function GetErrorDesignTimeHtml(ByVal exc As _
            Exception) As String

            Return CreatePlaceHolderDesignTimeHtml( _
                "<b>An error occurred</b>.<br>Check to ensure that all " + _
                "properties are valid.")
        End Function


        ' Override the Initialize method to ensure that
        ' only an instance of the SimpleDataList class is
        ' used by this designer class.
        Public Overrides Sub Initialize(ByVal component As IComponent)
            simpleList = CType(component, SimpleDataList)

            If IsNothing(simpleList) Then
                Throw New ArgumentException("Must be a SimpleDataList.", "component")
            End If

            MyBase.Initialize(component)
        End Sub
    End Class
End Namespace

下面的示例演示如何使用 DesignerAttribute 属性将设计器与 DataGrid 控件相关联。

' Override the Initialize method to ensure that
' only an instance of the SimpleDataList class is
' used by this designer class.
Public Overrides Sub Initialize(ByVal component As IComponent)
    simpleList = CType(component, SimpleDataList)

    If IsNothing(simpleList) Then
        Throw New ArgumentException("Must be a SimpleDataList.", "component")
    End If

    MyBase.Initialize(component)
End Sub

构造函数

DataGridDesigner()

初始化 DataGridDesigner 类的新实例。

属性

ActionLists	获取此设计器的设计器操作列表集合。 (继承自 BaseDataListDesigner)
ActiveTemplateEditingFrame	已过时. 获取活动的模板编辑框。 (继承自 TemplatedControlDesigner)
AllowResize	获取一个值，该值指示是否可以在设计时环境中调整控件的大小。 (继承自 ControlDesigner)
AssociatedComponents	获取与设计器所管理的组件关联的组件集合。 (继承自 ComponentDesigner)
AutoFormats	获取与此设计器关联的 DesignerAutoFormatCollection 对象。
Behavior	已过时. 获取或设置与设计器关联的 DHTML 行为。 (继承自 HtmlControlDesigner)
CanEnterTemplateMode	获取一个值，该值指示此设计器是否允许查看或编辑模板。 (继承自 TemplatedControlDesigner)
Component	获取此设计器正在设计的组件。 (继承自 ComponentDesigner)
DataBindings	获取当前控件的数据绑定集合。 (继承自 HtmlControlDesigner)
DataBindingsEnabled	获取一个值，该值指示设计器是否允许数据绑定。 (继承自 TemplatedControlDesigner)
DataKeyField	获取或设置关联控件的数据键字段的值。 (继承自 BaseDataListDesigner)
DataMember	获取或设置关联控件的数据成员字段的值。 (继承自 BaseDataListDesigner)
DataSource	获取或设置关联控件的数据源属性的值。 (继承自 BaseDataListDesigner)
DataSourceDesigner	获取数据源的设计器（如果已根据数据绑定的需要作了选择）。 (继承自 BaseDataListDesigner)
DataSourceID	获取或设置数据源 ID 属性的设计器版本，然后用来隐藏关联控件的相应属性。 (继承自 BaseDataListDesigner)
DesignerState	获取用于在设计时保持关联控件数据的对象。 (继承自 ControlDesigner)
DesignerView	获取与关联控件绑定的数据源的默认视图。 (继承自 BaseDataListDesigner)
DesignTimeElement	已过时. 获取一个设计时对象，该对象表示与设计图面上的 HtmlControlDesigner 对象关联的控件。 (继承自 HtmlControlDesigner)
DesignTimeElementView	已过时. 获取控件设计器的视图控件对象。 (继承自 ControlDesigner)
DesignTimeHtmlRequiresLoadComplete	获取一个值，该值指示是否必须完成加载才能显示设计时标记。 (继承自 BaseDataListDesigner)
Expressions	获取当前控件在设计时的表达式绑定。 (继承自 HtmlControlDesigner)
HidePropertiesInTemplateMode	获取一个值，该值指示当控件被置于模板编辑模式时是否将隐藏控件的属性。 (继承自 TemplatedControlDesigner)
ID	获取或设置控件的 ID 字符串。 (继承自 ControlDesigner)
InheritanceAttribute	获取一个特性，该特性指示关联组件的继承类型。 (继承自 ComponentDesigner)
Inherited	获取一个值，该值指示是否继承此组件。 (继承自 ComponentDesigner)
InTemplateMode	已过时. 获取一个值，该值指示设计器文档是否处于模板模式。 (继承自 TemplatedControlDesigner)
IsDirty	已过时. 获取或设置一个值，该值指示 Web 服务器控件是否已被标记为已更改。 (继承自 ControlDesigner)
ParentComponent	获取此设计器的父组件。 (继承自 ComponentDesigner)
ReadOnly	已过时. 获取或设置一个值，该值指示控件的属性在设计时是否为只读。 (继承自 ControlDesigner)
RootDesigner	获取包含关联控件的 Web 窗体页的控件设计器。 (继承自 ControlDesigner)
SetTextualDefaultProperty	扩展 DataGrid Web 服务器控件的设计时行为。 (继承自 ComponentDesigner)
ShadowProperties	获取重写用户设置的属性值的集合。 (继承自 ComponentDesigner)
ShouldCodeSerialize	已过时. 获取或设置一个值，该值指示在序列化期间是否应为当前设计文档在代码隐藏文件中创建控件的字段声明。 (继承自 HtmlControlDesigner)
Tag	获取表示关联控件的 HTML 标记元素的对象。 (继承自 ControlDesigner)
TemplateGroups	获取模板组的集合，每个模板组都包含一个模板定义。 (继承自 TemplatedControlDesigner)
UsePreviewControl	获取一个值，该值指示控件设计器是否使用临时预览控件来生成设计时 HTML 标记。 (继承自 ControlDesigner)
Verbs	获取此设计器可用的谓词的集合。 (继承自 BaseDataListDesigner)
ViewControl	获取或设置可用于预览设计时 HTML 标记的 Web 服务器控件。 (继承自 ControlDesigner)
ViewControlCreated	获取或设置一个值，该值指示是否已创建 View 控件以在设计图面上显示。 (继承自 ControlDesigner)
Visible	获取指示该控件在设计时是否可见的值。 (继承自 ControlDesigner)

方法

CreateErrorDesignTimeHtml(String)	创建在设计时显示指定错误消息的 HTML 标记。 (继承自 ControlDesigner)
CreateErrorDesignTimeHtml(String, Exception)	创建在设计时显示指定异常错误消息的 HTML 标记。 (继承自 ControlDesigner)
CreatePlaceHolderDesignTimeHtml()	提供一个简单的矩形占位符表示形式，该表示形式显示该控件的类型和 ID。 (继承自 ControlDesigner)
CreatePlaceHolderDesignTimeHtml(String)	提供一个简单的矩形占位符表示形式，该表示形式显示该控件的类型和 ID 以及指定的附加说明或信息。 (继承自 ControlDesigner)
CreateTemplateEditingFrame(TemplateEditingVerb)	已过时. 使用指定的谓词创建模板编辑框架。
CreateViewControl()	返回要在设计图面上查看或呈现的关联控件的副本。 (继承自 ControlDesigner)
Dispose()	释放由 ComponentDesigner 使用的所有资源。 (继承自 ComponentDesigner)
Dispose(Boolean)	释放由 DataGridDesigner 对象占用的非托管资源并（可选）释放托管资源。
DoDefaultAction()	在源代码文件中为组件的默认事件创建方法签名，并将用户的光标定位到该位置。 (继承自 ComponentDesigner)
EnterTemplateMode(ITemplateEditingFrame)	已过时. 打开特定的模板框对象以在设计器中进行编辑。 (继承自 TemplatedControlDesigner)
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
ExitTemplateMode(Boolean, Boolean, Boolean)	已过时. 保存所有相关的更改之后，关闭当前活动的模板编辑框。 (继承自 TemplatedControlDesigner)
GetBounds()	检索矩形的坐标，该矩形表示设计图面上显示的控件的边界。 (继承自 ControlDesigner)
GetCachedTemplateEditingVerbs()	已过时. 获取可用于设计器的缓存的模板编辑谓词。
GetDesignTimeDataSource(IEnumerable, Int32, Boolean)	生成可在设计时作为数据源使用的对象。 (继承自 BaseDataListDesigner)
GetDesignTimeDataSource(Int32, Boolean)	生成可在设计时作为数据源使用的对象。 (继承自 BaseDataListDesigner)
GetDesignTimeHtml()	获取设计时用于表示 DataGrid 控件的 HTML 标记。
GetDesignTimeHtml(DesignerRegionCollection)	检索用当前控件设计器区域显示控件并填充集合的 HTML 标记。 (继承自 ControlDesigner)
GetEditableDesignerRegionContent(EditableDesignerRegion)	返回关联控件设计时视图中可编辑区域的内容。 (继承自 ControlDesigner)
GetEmptyDesignTimeHtml()	获取设计时用于表示空白的基于模板的控件的 HTML 标记。
GetErrorDesignTimeHtml(Exception)	在呈现控件时遇到错误后获取设计时为指定的异常显示的 HTML 标记。
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetPersistenceContent()	在设计时检索该控件的持久内部 HTML 标记。 (继承自 ControlDesigner)
GetPersistInnerHtml()	获取要持久用于关联服务器控件运行时中的内容的标记。 (继承自 TemplatedControlDesigner)
GetResolvedSelectedDataSource()	从解析到特定数据成员的关联控件容器中获取数据源组件。 (继承自 BaseDataListDesigner)
GetSelectedDataSource()	从关联控件容器中获取数据源组件。 (继承自 BaseDataListDesigner)
GetService(Type)	尝试从设计器组件的设计模式站点检索指定类型的服务。 (继承自 ComponentDesigner)
GetTemplateContainerDataItemProperty(String)	已过时. 获取模板容器的数据项属性。
GetTemplateContainerDataSource(String)	已过时. 获取模板容器的数据源。 (继承自 BaseDataListDesigner)
GetTemplateContent(ITemplateEditingFrame, String, Boolean)	已过时. 获取模板的内容。
GetTemplateEditingVerbs()	已过时. 获取设计器可以使用的模板编辑谓词。 (继承自 TemplatedControlDesigner)
GetTemplateFromText(String)	从指定文本创建模板。 (继承自 TemplatedControlDesigner)
GetTemplatePropertyParentType(String)	已过时. 获取与指定模板的父级对应的 Type 对象。
GetTextFromTemplate(ITemplate)	获取表示指定模板的文本字符串。 (继承自 TemplatedControlDesigner)
GetType()	获取当前实例的 Type。 (继承自 Object)
GetViewRendering()	检索一个对象，该对象包含关联控件的内容和区域的设计时标记。 (继承自 ControlDesigner)
Initialize(IComponent)	用指定的 DataGrid 控件初始化设计器。
InitializeExistingComponent(IDictionary)	重新初始化现有组件。 (继承自 ComponentDesigner)
InitializeNewComponent(IDictionary)	初始化新创建的组件。 (继承自 ComponentDesigner)
InitializeNonDefault()	已过时. 对已初始化为非默认设置的导入组件的设置进行初始化。 (继承自 ComponentDesigner)
Invalidate()	使显示在设计图面上的控件的整个区域无效，并向控件设计器发送重新绘制控件的信号。 (继承自 ControlDesigner)
Invalidate(Rectangle)	使显示在设计图面上的控件的指定区域无效，并向控件设计器发送重新绘制控件的信号。 (继承自 ControlDesigner)
InvokeGetInheritanceAttribute(ComponentDesigner)	获取指定 InheritanceAttribute 的 ComponentDesigner。 (继承自 ComponentDesigner)
InvokePropertyBuilder(Int32)	调用关联控件的组件编辑器。 (继承自 BaseDataListDesigner)
IsPropertyBound(String)	已过时. 检索一个值，该值指示关联控件上的指定属性是否是数据绑定的。 (继承自 ControlDesigner)
Localize(IDesignTimeResourceWriter)	使用提供的资源编写器将关联控件的可本地化属性保持到设计宿主中的某个资源。 (继承自 ControlDesigner)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
OnAutoFormat(Object, EventArgs)	已过时. 处理 AutoFormat 事件。 (继承自 BaseDataListDesigner)
OnAutoFormatApplied(DesignerAutoFormat)	在已将自动格式设置方案应用到关联控件时调用。 (继承自 BaseDataListDesigner)
OnBehaviorAttached()	已过时. 提供将行为附加到设计器时进行附加处理的机会。 (继承自 TemplatedControlDesigner)
OnBehaviorDetaching()	已过时. 当某个行为与该元素取消关联时被调用。 (继承自 HtmlControlDesigner)
OnBindingsCollectionChanged(String)	已过时. 在数据绑定集合发生更改时调用。 (继承自 ControlDesigner)
OnClick(DesignerRegionMouseEventArgs)	当用户在设计时单击关联控件时由设计宿主调用。 (继承自 ControlDesigner)
OnColumnsChanged()	在模板的列更改时调用。
OnComponentChanged(Object, ComponentChangedEventArgs)	当关联的控件更改时调用。 (继承自 BaseDataListDesigner)
OnComponentChanging(Object, ComponentChangingEventArgs)	表示将处理关联控件的 ComponentChanging 事件的方法。 (继承自 ControlDesigner)
OnControlResize()	已过时. 关联的 Web 服务器控件的大小在设计宿主中发生设计时调整后被调用。 (继承自 ControlDesigner)
OnDataSourceChanged()	当关联控件的数据源发生更改时调用。 (继承自 BaseDataListDesigner)
OnPaint(PaintEventArgs)	当控件设计器在设计图面上绘制关联控件，且 CustomPaint 的值为 true 时调用。 (继承自 ControlDesigner)
OnPropertyBuilder(Object, EventArgs)	表示处理属性生成器事件的方法。 (继承自 BaseDataListDesigner)
OnSchemaRefreshed()	当关联控件的数据源架构更改时，将调用它。 (继承自 BaseDataListDesigner)
OnSetComponentDefaults()	已过时. 设置组件的默认属性。 (继承自 ComponentDesigner)
OnSetParent()	提供在此设计器的父级被更改时执行附加处理的机会。 (继承自 TemplatedControlDesigner)
OnStylesChanged()	可以重写以实现特定的功能，当关联控件的样式发生更改时必须出现此功能。 (继承自 BaseDataListDesigner)
OnTemplateEditingVerbsChanged()	在模板编辑谓词更改时调用。
OnTemplateModeChanged()	提供在模板模式被更改时执行附加处理的机会。 (继承自 TemplatedControlDesigner)
PostFilterAttributes(IDictionary)	允许设计器从通过 TypeDescriptor 公开的特性集中更改或移除项。 (继承自 ComponentDesigner)
PostFilterEvents(IDictionary)	允许设计器从通过 TypeDescriptor 公开的事件集中更改或移除项。 (继承自 ComponentDesigner)
PostFilterProperties(IDictionary)	允许设计器从通过 TypeDescriptor 公开的属性集中更改或移除项。 (继承自 ComponentDesigner)
PreFilterAttributes(IDictionary)	允许设计器在通过 TypeDescriptor 公开的特性集中添加项。 (继承自 ComponentDesigner)
PreFilterEvents(IDictionary)	设置在设计时为用于组件的 TypeDescriptor 对象公开的事件列表。 (继承自 HtmlControlDesigner)
PreFilterProperties(IDictionary)	供设计器使用，以从“属性”网格的显示中移除属性或向其添加其他属性或者隐藏关联控件的属性。 (继承自 BaseDataListDesigner)
RaiseComponentChanged(MemberDescriptor, Object, Object)	通知 IComponentChangeService 此组件已被更改。 (继承自 ComponentDesigner)
RaiseComponentChanging(MemberDescriptor)	通知 IComponentChangeService 此组件即将被更改。 (继承自 ComponentDesigner)
RaiseResizeEvent()	已过时. 引发 OnControlResize() 事件。 (继承自 ControlDesigner)
RegisterClone(Object, Object)	注册克隆控件中的内部数据。 (继承自 ControlDesigner)
SaveActiveTemplateEditingFrame()	保存活动的模板编辑框。 (继承自 TemplatedControlDesigner)
SetEditableDesignerRegionContent(EditableDesignerRegion, String)	指定设计时控件可编辑区域的内容。 (继承自 ControlDesigner)
SetRegionContent(EditableDesignerRegion, String)	指定控件设计时视图中可编辑区域的内容。 (继承自 ControlDesigner)
SetTemplateContent(ITemplateEditingFrame, String, String)	已过时. 为指定的模板和框架设置内容。
SetViewFlags(ViewFlags, Boolean)	将指定的按位 ViewFlags 枚举分配给指定的标志值。 (继承自 ControlDesigner)
ToString()	返回表示当前对象的字符串。 (继承自 Object)
UpdateDesignTimeHtml()	更新设计时 HTML。 (继承自 TemplatedControlDesigner)

显式接口实现

IDataBindingSchemaProvider.CanRefreshSchema	有关此成员的说明，请参见 CanRefreshSchema。 (继承自 BaseDataListDesigner)
IDataBindingSchemaProvider.RefreshSchema(Boolean)	有关此成员的说明，请参见 RefreshSchema(Boolean)。 (继承自 BaseDataListDesigner)
IDataBindingSchemaProvider.Schema	有关此成员的说明，请参见 Schema。 (继承自 BaseDataListDesigner)
IDesignerFilter.PostFilterAttributes(IDictionary)	有关此成员的说明，请参见 PostFilterAttributes(IDictionary) 方法。 (继承自 ComponentDesigner)
IDesignerFilter.PostFilterEvents(IDictionary)	有关此成员的说明，请参见 PostFilterEvents(IDictionary) 方法。 (继承自 ComponentDesigner)
IDesignerFilter.PostFilterProperties(IDictionary)	有关此成员的说明，请参见 PostFilterProperties(IDictionary) 方法。 (继承自 ComponentDesigner)
IDesignerFilter.PreFilterAttributes(IDictionary)	有关此成员的说明，请参见 PreFilterAttributes(IDictionary) 方法。 (继承自 ComponentDesigner)
IDesignerFilter.PreFilterEvents(IDictionary)	有关此成员的说明，请参见 PreFilterEvents(IDictionary) 方法。 (继承自 ComponentDesigner)
IDesignerFilter.PreFilterProperties(IDictionary)	有关此成员的说明，请参见 PreFilterProperties(IDictionary) 方法。 (继承自 ComponentDesigner)
ITreeDesigner.Children	有关此成员的说明，请参见 Children 属性。 (继承自 ComponentDesigner)
ITreeDesigner.Parent	有关此成员的说明，请参见 Parent 属性。 (继承自 ComponentDesigner)

另请参阅

• DataGrid
• DataGridComponentEditor
• GridView Web 服务器控件概述
• 扩展设计时支持
• 如何：在设计模式下扩展控件的外观和行为