Training
Certifications
Books
Special Offers
Community




 
Microsoft® .NET Framework 1.1 Class Library Reference Volume 5: System.Web
Author Microsoft Corporation
Pages 2768
Disk N/A
Level All Levels
Published 03/26/2003
ISBN 9780735618169
Price $79.99
To see this book's discounted price, select a reseller below.
 

More Information

About the Book
Table of Contents
Sample Chapter
Related Series
Related Books
About the Author

Support: Book & CD

Rate this book
Barnes Noble Amazon Quantum Books

 


Chapter : System.Web.UI.Design.WebControls Namespace continued


DataGridComponentEditor Class

Provides a component editor for a Web Forms DataGrid Web server control.

System.Object
   System.ComponentModel.ComponentEditor
      System.Windows.Forms.Design.WindowsFormsComponent-
      Editor
         System.Web.UI.Design.WebControls.BaseDataList-
         ComponentEditor
            System.Web.UI.Design.WebControls.DataGrid-
            ComponentEditor

[Visual Basic]

Public Class DataGridComponentEditor
Inherits BaseDataListComponentEditor

[C#]

public class DataGridComponentEditor : BaseDataListComponentEditor

[C++]

public __gc class DataGridComponentEditor : public
BaseDataListComponentEditor

[JScript]

public class DataGridComponentEditor extends
BaseDataListComponentEditor

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Requirements

Namespace: System.Web.UI.Design.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Design (in System.Design.dll)

DataGridComponentEditor Constructor

Initializes a new instance of the DataGridComponentEditor class.

Overload List

Initializes a new instance of the DataGridComponentEditor class.

   [Visual Basic] Public Sub New()

   [C#] public DataGridComponentEditor();

   [C++] public: DataGridComponentEditor();

   [JScript] public function DataGridComponentEditor();

Initializes a new instance of the DataGridComponentEditor class.

   [Visual Basic] Public Sub New(Integer)

   [C#] public DataGridComponentEditor(int);

   [C++] public: DataGridComponentEditor(int);

   [JScript] public function DataGridComponentEditor(int);

DataGridComponentEditor Constructor ()

Initializes a new instance of the DataGridComponentEditor class.

[Visual Basic]

Public Sub New()

[C#]

public DataGridComponentEditor();

[C++]

public: DataGridComponentEditor();

[JScript]

public function DataGridComponentEditor();

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridComponentEditor Constructor (Int32)

Initializes a new instance of the DataGridComponentEditor class.

[Visual Basic]

Public Sub New( _
ByVal initialPage As Integer _
)

[C#]

public DataGridComponentEditor(
int initialPage
);

[C++]

public: DataGridComponentEditor(
int initialPage
);

[JScript]

public function DataGridComponentEditor(
initialPage : int
);

Parameters

initialPage

   The index of the initial page.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridComponentEditor.GetComponentEditorPages Method

Gets the component editor pages shown for the DataGrid control in its associated ComponentEditor.

[Visual Basic]

Overrides Protected Function GetComponentEditorPages() As Type()

[C#]

protected override Type[] GetComponentEditorPages();

[C++]

protected: Type* GetComponentEditorPages() [];

[JScript]

protected override function GetComponentEditorPages() : Type[];

Return Value

An array consisting of the set of component editor pages.

Remarks

Notes to Inheritors:  This method can be overridden to change the set of pages to show.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner Class

Extends design-time behavior for the DataGrid Web server control.

System.Object
   System.ComponentModel.Design.ComponentDesigner
      System.Web.UI.Design.HtmlControlDesigner
         System.Web.UI.Design.ControlDesigner
            System.Web.UI.Design.TemplatedControlDesigner
               System.Web.UI.Design.WebControls.BaseDataList-
               Designer
                  System.Web.UI.Design.WebControls.DataGrid-
                  Designer

[Visual Basic]

Public Class DataGridDesigner
Inherits BaseDataListDesigner

[C#]

public class DataGridDesigner : BaseDataListDesigner

[C++]

public __gc class DataGridDesigner : public BaseDataListDesigner

[JScript]

public class DataGridDesigner extends BaseDataListDesigner

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Requirements

Namespace: System.Web.UI.Design.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Design (in System.Design.dll)

DataGridDesigner Constructor

Initializes a new instance of the DataGridDesigner class.

[Visual Basic]

Public Sub New()

[C#]

public DataGridDesigner();

[C++]

public: DataGridDesigner();

[JScript]

public function DataGridDesigner();

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.CreateTemplateEditingFrame Method

Creates a template editing frame using the specified verb.

[Visual Basic]

Overrides Protected Function CreateTemplateEditingFrame( _
ByVal verb As TemplateEditingVerb _
) As ITemplateEditingFrame

[C#]

protected override ITemplateEditingFrame CreateTemplateEditingFrame(
TemplateEditingVerb verb
);

[C++]

protected: ITemplateEditingFrame* CreateTemplateEditingFrame(
TemplateEditingVerb* verb
);

[JScript]

protected override function CreateTemplateEditingFrame(
verb : TemplateEditingVerb
) : ITemplateEditingFrame;

Parameters

verb

   The TemplateEditingVerb to create the template editing frame for.

Return Value

A new ITemplateEditingFrame.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.Dispose Method

Releases the unmanaged resources used by the DataGridDesigner and optionally releases the managed resources.

Overload List

Releases the unmanaged resources used by the DataGridDesigner and optionally releases the managed resources.

   [Visual Basic] Overloads Overrides Protected Sub Dispose(Boolean)

   [C#] protected override void Dispose(bool);

   [C++] protected: void Dispose(bool);

   [JScript] protected override function Dispose(Boolean);

Inherited from ComponentDesigner.

   [Visual Basic] Overloads Public Overridable Sub Dispose() Implements IDisposable.Dispose

   [C#] public virtual void Dispose();

   [C++] public: virtual void Dispose();

   [JScript] public function Dispose();

DataGridDesigner.Dispose Method (Boolean)

Releases the unmanaged resources used by the DataGridDesigner and optionally releases the managed resources.

[Visual Basic]

Overrides Overloads Protected Sub Dispose( _
ByVal disposing As Boolean _
)

[C#]

protected override void Dispose(
bool disposing
);

[C++]

protected: void Dispose(
bool disposing
);

[JScript]

protected override function Dispose(
disposing : Boolean
);

Parameters

disposing

   true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

This method is called by the public Dispose() method and the Finalize method. Dispose() invokes the protected Dispose(Boolean) method with the disposing parameter set to true. Finalize invokes Dispose with disposing set to false.

When the disposing parameter is true, this method releases all resources held by any managed objects that this DataGridDesigner references. This method invokes the Dispose() method of each referenced object.

Notes to Inheritors:   Dispose can be called multiple times by other objects. When overriding Dispose(Boolean), be careful not to reference objects that have been previously disposed of in an earlier call to Dispose.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.GetCachedTemplateEditingVerbs Method

Gets the cached template editing verbs.

[Visual Basic]

Overrides Protected Function GetCachedTemplateEditingVerbs() As _
TemplateEditingVerb()

[C#]

protected override TemplateEditingVerb

GetCachedTemplateEditingVerbs();

[C++]

protected: TemplateEditingVerb* GetCachedTemplateEditingVerbs() [];

[JScript]

protected override function GetCachedTemplateEditingVerbs() :
TemplateEditingVerb
;

Return Value

An array containing the cached template editing verbs.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.GetDesignTimeHtml Method

Gets the HTML that is used to represent the control at design time.

[Visual Basic]

Overrides Public Function GetDesignTimeHtml() As String

[C#]

public override string GetDesignTimeHtml();

[C++]

public: String* GetDesignTimeHtml();

[JScript]

public override function GetDesignTimeHtml() : String;

Return Value

The HTML that is used to represent the control at design time.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.GetEmptyDesignTimeHtml Method

Gets the HTML used to represent an empty template-based control at design time.

[Visual Basic]

Overrides Protected Function GetEmptyDesignTimeHtml() As String

[C#]

protected override string GetEmptyDesignTimeHtml();

[C++]

protected: String* GetEmptyDesignTimeHtml();

[JScript]

protected override function GetEmptyDesignTimeHtml() : String;

Return Value

The HTML used to represent an empty template-based control at design time.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.GetErrorDesignTimeHtml Method

Gets the HTML displayed at design-time for the specified exception when an error has been encountered while rendering the control.

[Visual Basic]

Overrides Protected Function GetErrorDesignTimeHtml( _
ByVal e As Exception _
) As String

[C#]

protected override string GetErrorDesignTimeHtml(
Exception e
);

[C++]

protected: String* GetErrorDesignTimeHtml(
Exception* e
);

[JScript]

protected override function GetErrorDesignTimeHtml(
e : Exception
) : String;

Parameters

e

   The exception to display an error message for.

Return Value

The HTML displayed at design-time for the specified exception.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.GetTemplateContainerDataItemProperty Method

Gets the data item property of the template's container.

[Visual Basic]

Overrides Public Function GetTemplateContainerDataItemProperty( _
ByVal templateName As String _
) As String

[C#]

public override string GetTemplateContainerDataItemProperty(
string templateName
);

[C++]

public: String* GetTemplateContainerDataItemProperty(
String* templateName
);

[JScript]

public override function GetTemplateContainerDataItemProperty(
templateName : String
) : String;

Parameters

templateName

   The name of the template.

Return Value

The data item property of the template's container.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.GetTemplateContent Method

Gets the template's content.

[Visual Basic]

Overrides Public Function GetTemplateContent( _
ByVal editingFrame As ITemplateEditingFrame, _
ByVal templateName As String, _
<Out()> ByRef allowEditing As Boolean _
) As String

[C#]

public override string GetTemplateContent(
ITemplateEditingFrame editingFrame,
string templateName,
out bool allowEditing
);

[C++]

public: String* GetTemplateContent(
ITemplateEditingFrame* editingFrame,
String* templateName,
[
Out
] bool* allowEditing
);

[JScript]

public override function GetTemplateContent(
editingFrame : ITemplateEditingFrame,
templateName : String,
allowEditing : Boolean
) : String;

Parameters

editingFrame

   The ITemplateEditingFrame to retrieve content for.

templateName

   The name of the template.

allowEditing

   true if the template's content can be edited; false if the content is read-only.

Return Value

The template's content.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.GetTemplatePropertyParentType Method

Gets the type of the parent with the template property.

[Visual Basic]

Overrides Public Function GetTemplatePropertyParentType( _
ByVal templateName As String _
) As Type

[C#]

public override Type GetTemplatePropertyParentType(
string templateName
);

[C++]

public: Type* GetTemplatePropertyParentType(
String* templateName
);

[JScript]

public override function GetTemplatePropertyParentType(
templateName : String
) : Type;

Parameters

templateName

   The name of the template to return the type of the parent for.

Return Value

The type of the object that has the template property.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.Initialize Method

Initializes the designer with the specified DataGrid control.

[Visual Basic]

Overrides Public Sub Initialize( _
ByVal component As IComponent _
) Implements IDesigner.Initialize

[C#]

public override void Initialize(
IComponent component
);

[C++]

public: void Initialize(
IComponent* component
);

[JScript]

public override function Initialize(
component : IComponent
);

Parameters

component

   The IComponent for the designer.

Implements

IDesigner.Initialize

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.OnColumnsChanged Method

Notification that is called when the columns changed event occurs.

[Visual Basic]

Public Overridable Sub OnColumnsChanged()

[C#]

public virtual void OnColumnsChanged();

[C++]

public: virtual void OnColumnsChanged();

[JScript]

public function OnColumnsChanged();

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.OnTemplateEditingVerbsChanged Method

Provides an opportunity to do processing or other actions when a change has been made to the template editing verbs.

[Visual Basic]

Overrides Protected Sub OnTemplateEditingVerbsChanged()

[C#]

protected override void OnTemplateEditingVerbsChanged();

[C++]

protected: void OnTemplateEditingVerbsChanged();

[JScript]

protected override function OnTemplateEditingVerbsChanged();

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataGridDesigner.SetTemplateContent Method

Sets the content for the specified template and frame.

[Visual Basic]

Overrides Public Sub SetTemplateContent( _
ByVal editingFrame As ITemplateEditingFrame, _
ByVal templateName As String, _
ByVal templateContent As String _
)

[C#]

public override void SetTemplateContent(
ITemplateEditingFrame editingFrame,
string templateName,
string templateContent
);

[C++]

public: void SetTemplateContent(
ITemplateEditingFrame* editingFrame,
String* templateName,
String* templateContent
);

[JScript]

public override function SetTemplateContent(
editingFrame : ITemplateEditingFrame,
templateName : String,
templateContent : String
);

Parameters

editingFrame

   The ITemplateEditingFrame to set the content for.

templateName

   The name of the template.

templateContent

   The content to set.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListComponentEditor Class

Provides a component editor for a Web Forms DataList control.

System.Object
   System.ComponentModel.ComponentEditor
      System.Windows.Forms.Design.WindowsFormsComponent-
      Editor
         System.Web.UI.Design.WebControls.BaseDataList-         ComponentEditor
            System.Web.UI.Design.WebControls.DataList-
            ComponentEditor

[Visual Basic]

Public Class DataListComponentEditor
Inherits BaseDataListComponentEditor

[C#]

public class DataListComponentEditor : BaseDataListComponentEditor

[C++]

public __gc class DataListComponentEditor : public
BaseDataListComponentEditor

[JScript]

public class DataListComponentEditor extends
BaseDataListComponentEditor

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Requirements

Namespace: System.Web.UI.Design.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Design (in System.Design.dll)

DataListComponentEditor Constructor

Initializes a new instance of DataListComponentEditor.

Overload List

Initializes a new instance of DataListComponentEditor.

   [Visual Basic] Public Sub New()

   [C#] public DataListComponentEditor();

   [C++] public: DataListComponentEditor();

   [JScript] public function DataListComponentEditor();

Initializes a new instance of DataListComponentEditor.

   [Visual Basic] Public Sub New(Integer)

   [C#] public DataListComponentEditor(int);

   [C++] public: DataListComponentEditor(int);

   [JScript] public function DataListComponentEditor(int);

DataListComponentEditor Constructor ()

Initializes a new instance of DataListComponentEditor.

[Visual Basic]

Public Sub New()

[C#]

public DataListComponentEditor();

[C++]

public: DataListComponentEditor();

[JScript]

public function DataListComponentEditor();

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListComponentEditor Constructor (Int32)

Initializes a new instance of DataListComponentEditor.

[Visual Basic]

Public Sub New( _
ByVal initialPage As Integer _
)

[C#]

public DataListComponentEditor(
int initialPage
);

[C++]

public: DataListComponentEditor(
int initialPage
);

[JScript]

public function DataListComponentEditor(
initialPage : int
);

Parameters

initialPage

   The index of the initial page to display.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListComponentEditor.GetComponentEditorPages Method

Gets the component editor pages shown for the DataList control in its associated ComponentEditor.

[Visual Basic]

Overrides Protected Function GetComponentEditorPages() As Type()

[C#]

protected override Type[] GetComponentEditorPages();

[C++]

protected: Type* GetComponentEditorPages() [];

[JScript]

protected override function GetComponentEditorPages() : Type[];

Return Value

An array of type Type that contains the pages owned by the designer.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner Class

Extends design-time behavior for the DataList Web server control.

System.Object
   System.ComponentModel.Design.ComponentDesigner
      System.Web.UI.Design.HtmlControlDesigner
         System.Web.UI.Design.ControlDesigner
            System.Web.UI.Design.TemplatedControlDesigner
               System.Web.UI.Design.WebControls.BaseDataList-
               Designer
                  System.Web.UI.Design.WebControls.DataList-
                  Designer

[Visual Basic]

Public Class DataListDesigner
Inherits BaseDataListDesigner

[C#]

public class DataListDesigner : BaseDataListDesigner

[C++]

public __gc class DataListDesigner : public BaseDataListDesigner

[JScript]

public class DataListDesigner extends BaseDataListDesigner

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Requirements

Namespace: System.Web.UI.Design.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Design (in System.Design.dll)

DataListDesigner Constructor

Initializes a new instance of the DataListDesigner class.

[Visual Basic]

Public Sub New()

[C#]

public DataListDesigner();

[C++]

public: DataListDesigner();

[JScript]

public function DataListDesigner();

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.AllowResize Property

Gets a value indicating whether the data list can be resized.

[Visual Basic]

Overrides Public ReadOnly Property AllowResize As Boolean

[C#]

public override bool AllowResize {get;}

[C++]

public: __property bool get_AllowResize();

[JScript]

public override function get AllowResize() : Boolean;

Property Value

true if the data list can be resized; otherwise, false.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.TemplatesExist Property

Gets a value that indicates whether templates associated with the designer currently exist.

[Visual Basic]

Protected ReadOnly Property TemplatesExist As Boolean

[C#]

protected bool TemplatesExist {get;}

[C++]

protected: __property bool get_TemplatesExist();

[JScript]

protected function get TemplatesExist() : Boolean;

Property Value

true if templates exist or the designer is in template mode; otherwise, false.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.CreateTemplateEditingFrame Method

Creates a template editing frame using the specified verb.

[Visual Basic]

Overrides Protected Function CreateTemplateEditingFrame( _
ByVal verb As TemplateEditingVerb _
) As ITemplateEditingFrame

[C#]

protected override ITemplateEditingFrame CreateTemplateEditingFrame(
TemplateEditingVerb verb
);

[C++]

protected: ITemplateEditingFrame* CreateTemplateEditingFrame(
TemplateEditingVerb* verb
);

[JScript]

protected override function CreateTemplateEditingFrame(
verb : TemplateEditingVerb
) : ITemplateEditingFrame;

Parameters

verb

   The TemplateEditingVerb that was invoked to create a template editing frame.

Return Value

An ITemplateEditingFrame.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.Dispose Method

Releases the unmanaged resources used by the DataListDesigner and optionally releases the managed resources.

Overload List

Releases the unmanaged resources used by the DataListDesigner and optionally releases the managed resources.

   [Visual Basic] Overloads Overrides Protected Sub Dispose(Boolean)

   [C#] protected override void Dispose(bool);

   [C++] protected: void Dispose(bool);

   [JScript] protected override function Dispose(Boolean);

Inherited from ComponentDesigner.

   [Visual Basic] Overloads Public Overridable Sub Dispose() Implements IDisposable.Dispose

   [C#] public virtual void Dispose();

   [C++] public: virtual void Dispose();

   [JScript] public function Dispose();

DataListDesigner.Dispose Method (Boolean)

Releases the unmanaged resources used by the DataListDesigner and optionally releases the managed resources.

[Visual Basic]

Overrides Overloads Protected Sub Dispose( _
ByVal disposing As Boolean _
)

[C#]

protected override void Dispose(
bool disposing
);

[C++]

protected: void Dispose(
bool disposing
);

[JScript]

protected override function Dispose(
disposing : Boolean
);

Parameters

disposing

   true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

This method is called by the public Dispose() method and the Finalize method. Dispose() invokes the protected Dispose(Boolean) method with the disposing parameter set to true. Finalize invokes Dispose with disposing set to false.

When the disposing parameter is true, this method releases all resources held by any managed objects that this DataListDesigner references. This method invokes the Dispose() method of each referenced object.

Notes to Inheritors:   Dispose can be called multiple times by other objects. When overriding Dispose(Boolean), be careful not to reference objects that have been previously disposed of in an earlier call to Dispose.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.GetCachedTemplateEditingVerbs Method

Gets the cached template editing verbs available to the designer.

[Visual Basic]

Overrides Protected Function GetCachedTemplateEditingVerbs() As _
TemplateEditingVerb()

[C#]

protected override TemplateEditingVerb

GetCachedTemplateEditingVerbs();

[C++]

protected: TemplateEditingVerb* GetCachedTemplateEditingVerbs() [];

[JScript]

protected override function GetCachedTemplateEditingVerbs() :
TemplateEditingVerb
;

Return Value

The cached template editing verbs available to the designer.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.GetDesignTimeHtml Method

Gets the HTML that is used to represent the control at design time.

[Visual Basic]

Overrides Public Function GetDesignTimeHtml() As String

[C#]

public override string GetDesignTimeHtml();

[C++]

public: String* GetDesignTimeHtml();

[JScript]

public override function GetDesignTimeHtml() : String;

Return Value

The HTML that is used to represent the control at design time.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.GetEmptyDesignTimeHtml Method

Gets the HTML used to represent an empty template-based control at design time.

[Visual Basic]

Overrides Protected Function GetEmptyDesignTimeHtml() As String

[C#]

protected override string GetEmptyDesignTimeHtml();

[C++]

protected: String* GetEmptyDesignTimeHtml();

[JScript]

protected override function GetEmptyDesignTimeHtml() : String;

Return Value

The HTML used to represent an empty template-based control at design time.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.GetErrorDesignTimeHtml Method

Gets the HTML to display at design-time for the specified exception when an error has been encountered while rendering the control.

[Visual Basic]

Overrides Protected Function GetErrorDesignTimeHtml( _
ByVal e As Exception _
) As String

[C#]

protected override string GetErrorDesignTimeHtml(
Exception e
);

[C++]

protected: String* GetErrorDesignTimeHtml(
Exception* e
);

[JScript]

protected override function GetErrorDesignTimeHtml(
e : Exception
) : String;

Parameters

e

   The Exception to display the error message for.

Return Value

The HTML displayed at design-time for the specified exception.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.GetTemplateContainerDataItemProperty Method

Gets the template container's data item property.

[Visual Basic]

Overrides Public Function GetTemplateContainerDataItemProperty( _
ByVal templateName As String _
) As String

[C#]

public override string GetTemplateContainerDataItemProperty(
string templateName
);

[C++]

public: String* GetTemplateContainerDataItemProperty(
String* templateName
);

[JScript]

public override function GetTemplateContainerDataItemProperty(
templateName : String
) : String;

Parameters

templateName

   The name of the template.

Return Value

The data item property of the container of the template.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.GetTemplateContent Method

Gets the template's content.

[Visual Basic]

Overrides Public Function GetTemplateContent( _
ByVal editingFrame As ITemplateEditingFrame, _
ByVal templateName As String, _
<Out()> ByRef allowEditing As Boolean _
) As String

[C#]

public override string GetTemplateContent(
ITemplateEditingFrame editingFrame,
string templateName,
out bool allowEditing
);

[C++]

public: String* GetTemplateContent(
ITemplateEditingFrame* editingFrame,
String* templateName,
[
Out
] bool* allowEditing
);

[JScript]

public override function GetTemplateContent(
editingFrame : ITemplateEditingFrame,
templateName : String,
allowEditing : Boolean
) : String;

Parameters

editingFrame

   The ITemplateEditingFrame to get content from.

templateName

   The name of the template.

allowEditing

   true if the template's content can be edited; false if the content is read-only.

Return Value

The template's content.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.Initialize Method

Initializes the designer with the specified component.

[Visual Basic]

Overrides Public Sub Initialize( _
ByVal component As IComponent _
) Implements IDesigner.Initialize

[C#]

public override void Initialize(
IComponent component
);

[C++]

public: void Initialize(
IComponent* component
);

[JScript]

public override function Initialize(
component : IComponent
);

Parameters

component

   The IComponent for the designer.

Implements

IDesigner.Initialize

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.OnTemplateEditingVerbsChanged Method

Provides an opportunity to do processing or other actions when a change has been made to the template editing verbs.

[Visual Basic]

Overrides Protected Sub OnTemplateEditingVerbsChanged()

[C#]

protected override void OnTemplateEditingVerbsChanged();

[C++]

protected: void OnTemplateEditingVerbsChanged();

[JScript]

protected override function OnTemplateEditingVerbsChanged();

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

DataListDesigner.SetTemplateContent Method

Sets the content for the specified template and frame.

[Visual Basic]

Overrides Public Sub SetTemplateContent( _
ByVal editingFrame As ITemplateEditingFrame, _
ByVal templateName As String, _
ByVal templateContent As String _
)

[C#]

public override void SetTemplateContent(
ITemplateEditingFrame editingFrame,
string templateName,
string templateContent
);

[C++]

public: void SetTemplateContent(
ITemplateEditingFrame* editingFrame,
String* templateName,
String* templateContent
);

[JScript]

public override function SetTemplateContent(
editingFrame : ITemplateEditingFrame,
templateName : String,
templateContent : String
);

Parameters

editingFrame

   The ITemplateEditingFrame to set content for.

templateName

   The name of the template.

templateContent

   The content to set.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

HyperLinkDesigner Class

Extends design-time behavior for the HyperLink Web server control.

System.Object
   System.ComponentModel.Design.ComponentDesigner
      System.Web.UI.Design.HtmlControlDesigner
         System.Web.UI.Design.ControlDesigner
            System.Web.UI.Design.TextControlDesigner
               System.Web.UI.Design.WebControls.HyperLink-
               Designer

[Visual Basic]

Public Class HyperLinkDesigner
Inherits TextControlDesigner

[C#]

public class HyperLinkDesigner : TextControlDesigner

[C++]

public __gc class HyperLinkDesigner : public TextControlDesigner

[JScript]

public class HyperLinkDesigner extends TextControlDesigner

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Remarks

HyperLinkDesigner overrides the GetDesignTimeHtml method of ControlDesigner to set any empty Text or NavigateUrl property on the control to ensure that the control is displayed with a meaningful representation at design-time.

Requirements

Namespace: System.Web.UI.Design.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Design (in System.Design.dll)

HyperLinkDesigner Constructor

Initializes a new instance of the HyperLinkDesigner class.

[Visual Basic]

Public Sub New()

[C#]

public HyperLinkDesigner();

[C++]

public: HyperLinkDesigner();

[JScript]

public function HyperLinkDesigner();

Remarks

The default constructor initializes any fields to their default values.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

HyperLinkDesigner.GetDesignTimeHtml Method

Gets the HTML that is used to represent the control at design time.

[Visual Basic]

Overrides Public Function GetDesignTimeHtml() As String

[C#]

public override string GetDesignTimeHtml();

[C++]

public: String* GetDesignTimeHtml();

[JScript]

public override function GetDesignTimeHtml() : String;

Return Value

The HTML that is used to represent the control at design time.

Remarks

This method determines whether the Text and NavigateUrl properties of the HyperLink control are data-bound. If the property is data-bound, this method sets the value of the Text property to "DataBound" and if the NavigateUrl property is data-bound, this method sets the value of the property to a text string so the control will have an appearence like a working hyperlink.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

LabelDesigner Class

Extends design-time behavior for the Label Web server control.

System.Object
   System.ComponentModel.Design.ComponentDesigner
      System.Web.UI.Design.HtmlControlDesigner
         System.Web.UI.Design.ControlDesigner
            System.Web.UI.Design.TextControlDesigner
               System.Web.UI.Design.WebControls.LabelDesigner

[Visual Basic]

Public Class LabelDesigner
Inherits TextControlDesigner

[C#]

public class LabelDesigner : TextControlDesigner

[C++]

public __gc class LabelDesigner : public TextControlDesigner

[JScript]

public class LabelDesigner extends TextControlDesigner

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Requirements

Namespace: System.Web.UI.Design.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Design (in System.Design.dll)

LabelDesigner Constructor

Initializes a new instance of the LabelDesigner class.

[Visual Basic]

Public Sub New()

[C#]

public LabelDesigner();

[C++]

public: LabelDesigner();

[JScript]

public function LabelDesigner();

Remarks

The default constructor initializes any fields to their default values.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

LinkButtonDesigner Class

Extends design-time behavior for the LinkButton Web server control.

System.Object
   System.ComponentModel.Design.ComponentDesigner
      System.Web.UI.Design.HtmlControlDesigner
         System.Web.UI.Design.ControlDesigner
            System.Web.UI.Design.TextControlDesigner
               System.Web.UI.Design.WebControls.LinkButton-
               Designer

[Visual Basic]

Public Class LinkButtonDesigner
Inherits TextControlDesigner

[C#]

public class LinkButtonDesigner : TextControlDesigner

[C++]

public __gc class LinkButtonDesigner : public TextControlDesigner

[JScript]

public class LinkButtonDesigner extends TextControlDesigner

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Requirements

Namespace: System.Web.UI.Design.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Design (in System.Design.dll)

LinkButtonDesigner Constructor

Initializes a new instance of the LinkButtonDesigner class.

[Visual Basic]

Public Sub New()

[C#]

public LinkButtonDesigner();

[C++]

public: LinkButtonDesigner();

[JScript]

public function LinkButtonDesigner();

Remarks

The default constructor initializes any fields to their default values.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDataBindingHandler Class

Provides a data-binding handler for a ListControl.

System.Object
   System.Web.UI.Design.DataBindingHandler
      System.Web.UI.Design.WebControls.ListControlData-
      BindingHandler

[Visual Basic]

Public Class ListControlDataBindingHandler
Inherits DataBindingHandler

[C#]

public class ListControlDataBindingHandler : DataBindingHandler

[C++]

public __gc class ListControlDataBindingHandler : public
DataBindingHandler

[JScript]

public class ListControlDataBindingHandler extends
DataBindingHandler

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Requirements

Namespace: System.Web.UI.Design.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Design (in System.Design.dll)

ListControlDataBindingHandler Constructor

Initializes a new instance of the ListControlDataBindingHandler class.

[Visual Basic]

Public Sub New()

[C#]

public ListControlDataBindingHandler();

[C++]

public: ListControlDataBindingHandler();

[JScript]

public function ListControlDataBindingHandler();

Remarks

The default constructor initializes any fields to their default values.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDataBindingHandler.DataBindControl Method

Performs data binding on the specified control.

[Visual Basic]

Overrides Public Sub DataBindControl( _
ByVal designerHost As IDesignerHost, _
ByVal control As Control _
)

[C#]

public override void DataBindControl(
IDesignerHost designerHost,
Control control
);

[C++]

public: void DataBindControl(
IDesignerHost* designerHost,
Control* control
);

[JScript]

public override function DataBindControl(
designerHost : IDesignerHost,
control : Control
);

Parameters

designerHost

   The IDesignerHost for the document that contains the control.

control

   The Control to bind.

Remarks

If the specified control has a data source specified within its data bindings, this method adds sample data-bound text to an empty list to use for the data source.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner Class

Extends design-time behavior for ListControl Web server controls.

System.Object
   System.ComponentModel.Design.ComponentDesigner
      System.Web.UI.Design.HtmlControlDesigner
         System.Web.UI.Design.ControlDesigner
            System.Web.UI.Design.WebControls.ListControl-
            Designer

[Visual Basic]

Public Class ListControlDesigner
Inherits ControlDesigner
Implements IDataSourceProvider

[C#]

public class ListControlDesigner : ControlDesigner,
IDataSourceProvider

[C++]

public __gc class ListControlDesigner : public ControlDesigner,
IDataSourceProvider

[JScript]

public class ListControlDesigner extends ControlDesigner implements
IDataSourceProvider

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Requirements

Namespace: System.Web.UI.Design.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Design (in System.Design.dll)

ListControlDesigner Constructor

Initializes a new instance of the ListControlDesigner class.

[Visual Basic]

Public Sub New()

[C#]

public ListControlDesigner();

[C++]

public: ListControlDesigner();

[JScript]

public function ListControlDesigner();

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.DataMember Property

Gets or sets the data member for the control.

[Visual Basic]

Public Property DataMember As String

[C#]

public string DataMember {get; set;}

[C++]

public: __property String* get_DataMember();
public: __property void set_DataMember(String*);

[JScript]

public function get DataMember() : String;
public function set DataMember(String);

Property Value

The DataMember property of the list control.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.DataSource Property

Gets or sets the data source property of the control.

[Visual Basic]

Public Property DataSource As String

[C#]

public string DataSource {get; set;}

[C++]

public: __property String* get_DataSource();
public: __property void set_DataSource(String*);

[JScript]

public function get DataSource() : String;
public function set DataSource(String);

Property Value

The DataSource property of the list control.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.DataTextField Property

Gets or sets the data text field of the control.

[Visual Basic]

Public Property DataTextField As String

[C#]

public string DataTextField {get; set;}

[C++]

public: __property String* get_DataTextField();
public: __property void set_DataTextField(String*);

[JScript]

public function get DataTextField() : String;
public function set DataTextField(String);

Property Value

The DataTextField property of the list control.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.DataValueField Property

Gets or sets the data value field of the control.

[Visual Basic]

Public Property DataValueField As String

[C#]

public string DataValueField {get; set;}

[C++]

public: __property String* get_DataValueField();
public: __property void set_DataValueField(String*);

[JScript]

public function get DataValueField() : String;
public function set DataValueField(String);

Property Value

The DataValueField property of the list control.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.GetDesignTimeHtml Method

Gets the HTML that is used to represent the control at design time.

[Visual Basic]

Overrides Public Function GetDesignTimeHtml() As String

[C#]

public override string GetDesignTimeHtml();

[C++]

public: String* GetDesignTimeHtml();

[JScript]

public override function GetDesignTimeHtml() : String;

Return Value

The HTML that is used to represent the control at design time.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.GetResolvedSelectedDataSource Method

Gets the data member that is currently selected within the data source currently bound to the control.

[Visual Basic]

Public Overridable Function GetResolvedSelectedDataSource() As _
IEnumerable Implements _
IDataSourceProvider.GetResolvedSelectedDataSource

[C#]

public virtual IEnumerable GetResolvedSelectedDataSource();

[C++]

public: virtual IEnumerable* GetResolvedSelectedDataSource();

[JScript]

public function GetResolvedSelectedDataSource() : IEnumerable;

Return Value

The currently selected data member, or a null reference (Nothing in Visual Basic) if the control was not bound to a data source, or the data source, site of the designer's component, or the container of the data source could not be accessed.

Implements

IDataSourceProvider.GetResolvedSelectedDataSource

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.GetSelectedDataSource Method

Gets the selected data source component from the component's container.

[Visual Basic]

Public Overridable Function GetSelectedDataSource() As Object _
Implements IDataSourceProvider.GetSelectedDataSource

[C#]

public virtual object GetSelectedDataSource();

[C++]

public: virtual Object* GetSelectedDataSource();

[JScript]

public function GetSelectedDataSource() : Object;

Return Value

The selected data source, or a null reference (Nothing in Visual Basic) if a data source is not found or if a data source with the same name does not exist.

Implements

IDataSourceProvider.GetSelectedDataSource

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.Initialize Method

Initializes the designer with the specified component.

[Visual Basic]

Overrides Public Sub Initialize( _
ByVal component As IComponent _
) Implements IDesigner.Initialize

[C#]

public override void Initialize(
IComponent component
);

[C++]

public: void Initialize(
IComponent* component
);

[JScript]

public override function Initialize(
component : IComponent
);

Parameters

component

   The IComponent for the designer.

Implements

IDesigner.Initialize

Remarks

This method is called to initialize the designer with the component to design.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.OnComponentChanged Method

Raises the ComponentChanged event.

[Visual Basic]

Overrides Public Sub OnComponentChanged( _
ByVal source As Object, _
ByVal ce As ComponentChangedEventArgs _
)

[C#]

public override void OnComponentChanged(
object source,
ComponentChangedEventArgs ce
);

[C++]

public: void OnComponentChanged(
Object* source,
ComponentChangedEventArgs* ce
);

[JScript]

public override function OnComponentChanged(
source : Object,
ce : ComponentChangedEventArgs
);

Parameters

source

   The source of the event.

ce

   A ComponentChangedEventArgs that contains the event data.

Remarks

Handles changes made to the component. This includes changes made in the Properties window.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.OnDataSourceChanged Method

Raises the DataSourceChanged event.

[Visual Basic]

Public Overridable Sub OnDataSourceChanged()

[C#]

public virtual void OnDataSourceChanged();

[C++]

public: virtual void OnDataSourceChanged();

[JScript]

public function OnDataSourceChanged();

Remarks

Handles changes made to the data source.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.

ListControlDesigner.PreFilterProperties Method

Filters the properties exposed through a TypeDescriptor and replaces the property descriptor for the DataSource property, which contains the value used at runtime, with a property descriptor that contains a value indicating a design-time data source.

[Visual Basic]

Overrides Protected Sub PreFilterProperties( _
ByVal properties As IDictionary _
)

[C#]

protected override void PreFilterProperties(
IDictionary properties
);

[C++]

protected: void PreFilterProperties(
IDictionary* properties
);

[JScript]

protected override function PreFilterProperties(
properties : IDictionary
);

Parameters

properties

   An IDictionary that contains the set of properties to expose for the control.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

  • Full trust for the immediate caller. This member cannot be used by partially trusted code.


Previous   |  Table of Contents   |   Next



Last Updated: March 12, 2003
Top of Page