Patent Grant
7644414
This invention relates to network software, such as Web applications, and to computer software development of such network software. More particularly, this invention relates to an application program interface (API) that facilitates use of a network software platform by application programs and computer hardware.
Very early on, computer software came to be categorized as “operating system” software or “application” software. Broadly speaking, an application is software meant to perform a specific task for the computer user such as solving a mathematical equation or supporting word processing. The operating system is the software that manages and controls the computer hardware. The goal of the operating system is to make the computer resources available to the application programmer while at the same time, hiding the complexity necessary to actually control the hardware.
The operating system makes the resources available via functions that are collectively known as the Application Program Interface or API. The term API is also used in reference to a single one of these functions. The functions are often grouped in terms of what resource or service they provide to the application programmer. Application software requests resources by calling individual API functions. API functions also serve as the means by which messages and information provided by the operating system are relayed back to the application software.
In addition to changes in hardware, another factor driving the evolution of operating system software has been the desire to simplify and speed application software development. Application software development can be a daunting task, sometimes requiring years of developer time to create a sophisticated program with millions of lines of code. For a popular operating system such as Microsoft Windows®, application software developers write thousands of different applications each year that utilize the operating system. A coherent and usable operating system base is required to support so many diverse application developers.
Often, development of application software can be made simpler by making the operating system more complex. That is, if a function may be useful to several different application programs, it may be better to write it once for inclusion in the operating system, than requiring dozens of software developers to write it dozens of times for inclusion in dozens of different applications. In this manner, if the operating system supports a wide range of common functionality required by a number of applications, significant savings in applications software development costs and time can be achieved.
Regardless of where the line between operating system and application software is drawn, it is clear that for a useful operating system, the API between the operating system and the computer hardware and application software is as important as efficient internal operation of the operating system itself.
Over the past few years, the universal adoption of the Internet, and networking technology in general, has changed the landscape for computer software developers. Traditionally, software developers focused on single-site software applications for standalone desktop computers, or LAN-based computers that were connected to a limited number of other computers via a local area network (LAN). Such software applications were typically referred to as “shrink wrapped” products because the software was marketed and sold in a shrink-wrapped package. The applications utilized well-defined APIs to access the underlying operating system of the computer.
As the Internet evolved and gained widespread acceptance, the industry began to recognize the power of hosting applications at various sites on the World Wide Web (or simply the “Web”). In the networked world, clients from anywhere could submit requests to server-based applications hosted at diverse locations and receive responses back in fractions of a second. These Web applications, however, were typically developed using the same operating system platform that was originally developed for standalone computing machines or locally networked computers. Unfortunately, in some instances, these applications do not adequately transfer to the distributed computing regime. The underlying platform was simply not constructed with the idea of supporting limitless numbers of interconnected computers.
To accommodate the shift to the distributed computing environment being ushered in by the Internet, Microsoft Corporation is developing a network software platform known as the “.NET” platform (read as “Dot Net”). The platform allows developers to create Web services that will execute over the Internet. Such a dynamic shift requires a new ground-up design of an entirely new API.
In response to this challenge, the inventors developed a unique set of API functions for Microsoft's .NET™ platform.
An application program interface (API) provides a set of functions for application developers who build Web applications on a network platform, such as Microsoft Corporation's .NET™ platform.
The same numbers are used throughout the drawings to reference like features.
Accompanying this specification is a compact disc that stores a compiled HTML help file identifying the API (application program interface) for Microsoft's .NET™ network platform. The file is named “cpref.chm” and was created on Jun. 8, 2001. It is 30.81 Mbytes in size. The file can be executed on a Windows®-based computing device (e.g., IBM-PC, or equivalent) that executes a Windows®-brand operating system (e.g., Windows® NT, Windows® 98, Windows® 2000, etc.). The compiled HTML help file stored on the compact disk is hereby incorporated by reference.
Additionally, the APIs contained in the compiled HTML help file are also provided in approximately 100 separate text files named “NamespaceName.txt”. The text files comply with the ASCII format.
The compact disc itself is a CD-ROM, and conforms to the ISO 9660 standard.
This disclosure addresses an application program interface (API) for a network platform upon which developers can build Web applications and services. More particularly, an exemplary API is described for the .NET™ platform created by Microsoft Corporation. The .NET™ platform is a software platform for Web services and Web applications implemented in the distributed computing environment. It represents the next generation of Internet computing, using open communication standards to communicate among loosely coupled Web services that are collaborating to perform a particular task.
In the described implementation, the .NET™ platform utilizes XML (extensible markup language), an open standard for describing data. XML is managed by the World Wide Web Consortium (W3C). XML is used for defining data elements on a Web page and business-to-business documents. XML uses a similar tag structure as HTML; however, whereas HTML defines how elements are displayed, XML defines what those elements contain. HTML uses predefined tags, but XML allows tags to be defined by the developer of the page. Thus, virtually any data items can be identified, allowing Web pages to function like database records. Through the use of XML and other open protocols, such as Simple Object Access Protocol (SOAP), the .NET™ platform allows integration of a wide range of services that can be tailored to the needs of the user. Although the embodiments described herein are described in conjunction with XML and other open standards, such are not required for the operation of the claimed invention. Other equally viable technologies will suffice to implement the inventions described herein.
As used herein, the phrase application program interface or API includes traditional interfaces that employ method or function calls, as well as remote calls (e.g., a proxy, stub relationship) and SOAP/XML invocations.
Exemplary Network Environment
Web services 102 are accessible directly by other services (as represented by communication link 106) or a software application, such as Web application 110 (as represented by communication links 112 and 114). Each Web service 102 is illustrated as including one or more servers that execute software to handle requests for particular services. Such services often maintain databases that store information to be served back to requesters. Web services may be configured to perform any one of a variety of different services. Examples of Web services include login verification, notification, database storage, stock quoting, location directories, mapping, music, electronic wallet, calendar/scheduler, telephone listings, news and information, games, ticketing, and so on. The Web services can be combined with each other and with other applications to build intelligent interactive experiences.
The network environment 100 also includes representative client devices 120(1), 120(2), 120(3), 120(4), . . . , 120(M) that utilize the Web services 102 (as represented by communication link 122) and/or the Web application 110 (as represented by communication links 124, 126, and 128). The clients may communicate with one another using standard protocols as well, as represented by an exemplary XML link 130 between clients 120(3) and 120(4).
The client devices, referenced generally as number 120, can be implemented many different ways. Examples of possible client implementations include, without limitation, portable computers, stationary computers, tablet PCs, televisions/set-top boxes, wireless communication devices, personal digital assistants, gaming consoles, printers, photocopiers, and other smart devices.
The Web application 110 is an application designed to run on the network platform and may utilize the Web services 102 when handling and servicing requests from clients 120. The Web application 110 is composed of one or more software applications 130 that run atop a programming framework 132, which are executing on one or more servers 134 or other computer systems. Note that a portion of Web application 110 may actually reside on one or more of clients 120. Alternatively, Web application 110 may coordinate with other software on clients 120 to actually accomplish its tasks.
The programming framework 132 is the structure that supports the applications and services developed by application developers. It permits multi-language development and seamless integration by supporting multiple languages. It supports open protocols, such as SOAP, and encapsulates the underlying operating system and object model services. The framework provides a robust and secure execution environment for the multiple programming languages and offers secure, integrated class libraries.
The framework 132 is a multi-tiered architecture that includes an application program interface (API) layer 142, a common language runtime (CLR) layer 144, and an operating system/services layer 146. This layered architecture allows updates and modifications to various layers without impacting other portions of the framework. A common language specification (CLS) 140 allows designers of various languages to write code that is able to access underlying library functionality. The specification 140 functions as a contract between language designers and library designers that can be used to promote language interoperability. By adhering to the CLS, libraries written in one language can be directly accessible to code modules written in other languages to achieve seamless integration between code modules written in one language and code modules written in another language. One exemplary detailed implementation of a CLS is described in an ECMA standard created by participants in ECMA TC39/TG3. The reader is directed to the ECMA web site at www.ecma.ch.
The API layer 142 presents groups of functions that the applications 130 can call to access the resources and services provided by layer 146. By exposing the API functions for a network platform, application developers can create Web applications for distributed computing systems that make full use of the network resources and other Web services, without needing to understand the complex interworkings of how those network resources actually operate or are made available. Moreover, the Web applications can be written in any number of programming languages, and translated into an intermediate language supported by the common language runtime 144 and included as part of the common language specification 140. In this way, the API layer 142 can provide methods for a wide and diverse variety of applications.
Additionally, the framework 132 can be configured to support API calls placed by remote applications executing remotely from the servers 134 that host the framework. Representative applications 148(1) and 148(2) residing on clients 120(3) and 120(M), respectively, can use the API functions by making calls directly, or indirectly, to the API layer 142 over the network 104.
The framework may also be implemented at the clients. Client 120(3) represents the situation where a framework 150 is implemented at the client. This framework may be identical to server-based framework 132, or modified for client purposes. Alternatively, the client-based framework may be condensed in the event that the client is a limited or dedicated function device, such as a cellular phone, personal digital assistant, handheld computer, or other communication/computing device.
Developers' Programming Framework
The framework 132 encapsulates the operating system 146(1) (e.g., Windows®-brand operating systems) and object model services 146(2) (e.g., Component Object Model (COM) or Distributed COM). The operating system 146(1) provides conventional functions, such as file management, notification, event handling, user interfaces (e.g., windowing, menus, dialogs, etc.), security, authentication, verification, processes and threads, memory management, and so on. The object model services 146(2) provide interfacing with other objects to perform various tasks. Calls made to the API layer 142 are handed to the common language runtime layer 144 for local execution by the operating system 146(1) and/or object model services 146(2).
The API 142 groups API functions into multiple namespaces. Namespaces essentially define a collection of classes, interfaces, delegates, enumerations, and structures, which are collectively called “types”, that provide a specific set of related functionality. A class represents managed heap allocated data that has reference assignment semantics. A delegate is an object oriented function pointer. An enumeration is a special kind of value type that represents named constants. A structure represents static allocated data that has value assignment semantics. An interface defines a contract that other types can implement.
By using namespaces, a designer can organize a set of types into a hierarchical namespace. The designer is able to create multiple groups from the set of types, with each group containing at least one type that exposes logically related functionality. In the exemplary implementation, the API 142 is organized into four root namespaces: a first namespace 200 for Web applications, a second namespace 202 for client applications, a third namespace 204 for data and XML, and a fourth namespace 206 for base class libraries (BCLs). Each group can then be assigned a name. For instance, types in the Web applications namespace 200 are assigned the name “Web”, and types in the data and XML namespace 204 can be assigned names “Data” and “XML” respectively. The named groups can be organized under a single “global root” namespace for system level APIs, such as an overall System namespace. By selecting and prefixing a top level identifier, the types in each group can be easily referenced by a hierarchical name that includes the selected top level identifier prefixed to the name of the group containing the type. For instance, types in the Web applications namespace 200 can be referenced using the hierarchical name “System.Web”. In this way, the individual namespaces 200, 202, 204, and 206 become major branches off of the System namespace and can carry a designation where the individual namespaces are prefixed with a designator, such as a “System.” prefix.
The Web applications namespace 200 pertains to Web based functionality, such as dynamically generated Web pages (e.g., Microsoft's Active Server Pages (ASP)). It supplies types that enable browser/server communication. The client applications namespace 202 pertains to drawing and client side UI functionality. It supplies types that enable drawing of two-dimensional (2D), imaging, and printing, as well as the ability to construct window forms, menus, boxes, and so on.
The data and XML namespace 204 relates to connectivity to data sources and XML functionality. It supplies classes, interfaces, delegates, and enumerations that enable security, specify data types, and serialize objects into XML format documents or streams. The base class libraries (BCL) namespace 206 pertains to basic system and runtime functionality. It contains the fundamental types and base classes that define commonly-used value and reference data types, events and event handlers, interfaces, attributes, and processing exceptions.
In addition to the framework 132, programming tools 210 are provided to assist the developer in building Web services and/or applications. One example of the programming tools 200 is Visual Studio™, a multi-language suite of programming tools offered by Microsoft Corporation.
Root API Namespaces
The Web applications namespace 200 (“System.Web”) defines additional namespaces, including:
The client applications namespace 202 is composed of two namespaces:
The data and XML namespace 204 is composed of two namespaces:
The base class library namespace 206 (“System”) includes the following namespaces:
The web applications namespace 200 (“System.Web”) defines several additional namespaces, including the services namespace 300 (“System.Web.Services”), a caching namespace 308 (“System.Web.Caching”), a configuration namespace 310 (“System.Web.Configuration”), a UI namespace 312 (“System.Web.UI”), a security namespace 318 (“System.Web.Security”), and a session state namespace 320 (“System.Web.SessionState”). In general, the web applications namespace 200 supplies tools that enable browser-server communication.
The services namespace 300 contains classes that allow developers to build and use various web services. The services namespace includes a web service class that defines a base class for web services and a web method attribute class that allows a method to be programmatically exposed over the web.
The UI namespace 312 contains classes that allow a user to create HTML server controls on a web page. These HTML server controls execute on the server and map to standard HTML tags. The UI namespace also contains classes that allow a user to create web server controls on a web page. These web server controls run on the web server and include form controls, such as buttons and text boxes.
The web applications namespace 200 also includes classes for manipulating cookies, transferring files, handling exception information, and controlling an output cache. Specific details regarding the System.Web namespace are provided below.
System.Web
Description
The System.Web namespace supplies classes and interfaces that enable browser/server communication. This namespace includes the HTTPRequest class that provides extensive information about the current HTTP request, the HTTPResponse class that manages HTTP output to the client, and the HTTPServerUtility object that provides access to server-side utilities and processes. System.Web also includes classes for cookie manipulation, file transfer, exception information, and output cache control.
BeginEventHandler delegate (System.Web)
Description
EndEventHandler delegate (System.Web)
Description
HttpWorkerRequest.EndOfSendNotification delegate (System.Web)
Description
HttpApplication class (System.Web)
Description
Defines the methods, properties, and events common to all application objects within an ASP.NET application.
Constructors:
HttpApplication
Example Syntax:
Properties:
Application
Gets a reference to an HTTPApplication state bag instance.
Context
Gets the HTTPRuntime—provided context object that provides access to additional pipeline-module exposed objects.
Events
Modules
Gets the collection of HTTPModules configured for the current application.
Request
Gets the intrinsic object that provides access to incoming HttpRequest data.
Response
The intrinsic object that allows transmission of HttpResponse data to a client.
Server
Gets the intrinsic Server object.
Session
Gets the intrinsic Session object that provides access to session data.
Site
User
Gets the User intrinsic object.
Methods:
AddOnAcquireRequestStateAsync
AddOnAuthenticateRequestAsync
AddOnAuthorizeRequestAsync
AddOnBeginRequestAsync
AddOnEndRequestAsync
AddOnPostRequestHandlerExecuteAsync
AddOnPreRequestHandlerExecuteAsync
AddOnReleaseRequestStateAsync
AddOnResolveRequestCacheAsync
AddOnUpdateRequestCacheAsync
CompleteRequest
Dispose
Cleans up the instance variables of an HttpModule.
The System.Web.HttpApplication.Request, System.Web.HttpApplication.Response, System.Web.HttpApplication.Session and System.Web.HttpApplication.Application properties are not available for use at the time System.Web.HttpApplication.Dispose is executed.
GetVaryByCustomString
Init
Initializes HttpModule instance variables and register event handlers with the hosting Application.
IHttpAsyncHandler.BeginProcessRequest
IHttpAsyncHandler.EndProcessRequest
IHttpHandler.ProcessRequest
HttpApplicationState class (System.Web)
ToString
Description
Enables sharing of global information across multiple sessions and requests within an ASP.NET application.
An ASP.NET application is the sum of all files, pages, handlers, modules, and code within the scope of a virtual directory and its subdirectories on a single web server.
AllKeys
ToString
Gets the access keys in the System.Web.HttpApplicationState collection.
Contents
ToString
Gets a reference to the System.Web.HttpApplicationState object.
This property provides compatibility with earlier versions of ASP.
Count
ToString
Gets the number of objects in the System.Web.HttpApplicationState collection.
IsReadOnly
Item
ToString
System.Web.HttpApplicationState
Description
Gets the value of a single System.Web.HttpApplicationState object by name. The name of the object in the collection.
Item
ToString
Gets a single System.Web.HttpApplicationState object by index. The numerical index of the object in the collection.
Keys
StaticObjects
ToString
Description
Gets all objects declared via an tag within the ASP.NET application.
Application objects are defined in the Global.asax file.
Add
Adds a new object to the System.Web.HttpApplicationState collection. The name of the object to be added to the collection. The value of the object.
Clear
Removes all objects from an System.Web.HttpApplicationState collection.
Get
Gets an System.Web.HttpApplicationState object by numerical index.
Return Value: The object referenced by index. The index of the application state object.
Get
Gets an System.Web.HttpApplicationState object by name.
Return Value: The object referenced by name.
The following example returns an object named MyAppVarl from the System.Web.HttpApplicationState collection of the intrinsic System.Web.HttpContext.Application object and copies it to a new object variable. The name of the object.
GetKey
Gets an System.Web.HttpApplicationState object name by index.
Return Value: The name under which the application state object was saved. The index of the application state object.
Lock
Locks access to an System.Web.HttpApplicationState variable to facilitate access synchronization.
Remove
Removes the named object from an System.Web.HttpApplicationState collection. The name of the object to be removed from the collection.
RemoveAll
Removes all objects from an System.Web.HttpApplicationState collection.
System.Web.HttpApplicationState.RemoveAll is an internal call to System.Web.IHttpApplicationState.Clear.
RemoveAt
Set
Updates the value of an object in an System.Web.HttpApplicationState collection. The name of the object to be updated. The updated value of the object.
UnLock
Unlocks access to an System.Web.HttpApplicationState variable to facilitate access synchronization.
HttpBrowserCapabilities class (System.Web)
UnLock
Description
Enables the server to gather information on the capabilities of the browser that is running on the client.
System.Web.HttpBrowserCapabilities properties are accessible through the System.Web.HttpRequest.Browser property of ASP.NET's intrinsic System.Web.HttpContext.Request object.
HttpBrowserCapabilities
Example Syntax:
UnLock
ActiveXControls
UnLock
Gets a value indicating whether the client browser supports ActiveX controls.
AOL
UnLock
Gets a value indicating whether the client is an America Online (AOL) browser.
BackgroundSounds
UnLock
Gets a value indicating whether the client browser supports background sounds.
Beta
UnLock
Gets a value indicating whether the browser is a beta release.
Browser
UnLock
Gets the browser string (if any) that was transmitted in the User-Agent header.
CDF
UnLock
Gets a value indicating whether the client browser supports Channel Definition Format (CDF) for webcasting.
ClrVersion
UnLock
Gets the version number of the NET common language runtime that the client browser supports.
If no common language runtime version is specified, the property value is 0, 0,−1,−1.
Cookies
UnLock
Gets a value indicating whether the client browser supports cookies.
Crawler
UnLock
Gets a value indicating whether the client browser is a Web crawler search engine.
EcmaScriptVersion
UnLock
Gets the version number of ECMA script that the client browser supports.
The European Computer Manufacturer's Association develops standards for information and communication systems. For more information, see ECMA's official Web site at http://www.ecma.ch.
Frames
UnLock
Gets a value indicating whether the client browser supports HTML frames.
Item
JavaApplets
UnLock
Description
Gets a value indicating whether the client browser supports Java applets.
JavaScript
UnLock
Gets a value indicating whether the client browser supports JavaScript.
MajorVersion
UnLock
Gets the major (that is, integer) version number of the client browser.
MinorVersion
UnLock
Gets the minor (that is, decimal) version number of the client browser.
MSDomVersion
UnLock
Gets the version of Microsoft HTML (MSHTML) Document Object Model (DOM) that the client browser supports.
Platform
UnLock
Gets the name of the platform that the client uses.
Some possible Platform values are: Unknown, Win95, Win98, WinNT (which includes Windows 2000), Win16, WinCE, Mac68K, MacPPC, UNIX, and WebTV.
Tables
UnLock
Gets a value indicating whether the client browser supports HTML tables.
TagWriter
UnLock
Type
UnLock
Gets the name and major (that is, integer) version number of the client browser.
VBScript
UnLock
Gets a value indicating whether the client browser supports VBScript.
Version
UnLock
Gets the full (integer and decimal) version number of the client browser.
W3CDomVersion
UnLock
Gets the version of the World Wide Web Consortium (W3C) XML Document Object Model (DOM) that the client browser supports.
Win16
UnLock
Gets a value indicating whether the client is a Win16-based machine.
Win32
UnLock
Gets a value indicating whether the client is a Win32-based machine.
HttpCacheability enumeration (System.Web)
ToString
Description
Provides enumerated values that are used to set the Cache-Control HTTP header.
ToString
Sets the Cache-Control: no-cache header. Without a field name, the directive applies to the entire request and a shared (proxy server) cache must force a successful revalidation with the origin Web server before satisfying the request. With a field name, the directive applies only to the named field; the rest of the response may be supplied from a shared cache.
ToString
Default value. Sets Cache-Control: private to specify that the response is cacheable only on the client and not by shared (proxy server) caches.
ToString
Sets Cache-Control: public to specify that the response is cacheable by clients and shared (proxy) caches.
ToString
Specifies that the response is cached only at the origin server. Similar to the NoCache option. Clients receive a Cache-Control: no-cache directive but the document is cached on the origin server.
HttpCachePolicy class (System.Web)
ToString
Description
Contains methods for setting cache-specific HTTP headers and for controlling the ASP.NET page output cache.
For background information on HTTP headers and controlling caching, see the document RFC 2616: Hypertext Transfer Protocol—HTTP/1.1, available on the World Wide Web Consortium's site at http://www.w3c.org.
VaryByHeaders
ToString
Gets the list of all HTTP headers that will be used to vary cache output.
When a cached item has several vary headers, a separate version of the requested document is available from the cache for each HTTP header type.
VaryByParams
ToString
Gets the list of parameters received by a GET (querystring) or POST (in the body of the HTTP request) that affect caching.
For each named parameter in VaryByParams a separate version of the requested document is available from the cache, the version varying by the parameter's value.
AddValidationCallback
Registers a validation callback for the current response.
AddValidationCallback provides a mechanism to programmatically check the validity of a item in the cache before the item is returned from the cache. The System.Web.HttpCacheValidateHandler value. The arbitrary user-supplied data that is passed back to the AddValidationCallback delegate.
AppendCacheExtension
Appends the specified text to the Cache-Control HTTP header.
If the browser does not recognize cache control directives or extensions, the browser must ignore the unrecognized terms. For more information, see the document RFC 2616: Hypertext Transfer Protocol—HTTP/1.1, available on the World Wide Web Consortium's site at http://www.w3c.org. The text to append to the Cache-Control header.
SetCacheability
Sets the Cache-Control header to one of the values of System.Web.HttpCacheability. An System.Web.HttpCacheability enumeration value.
SetCacheability
Sets the Cache-Control header to one of the values of System.Web.HttpCacheability and appends an extension to the directive.
The field name extension is valid only when used with the private or no-cache directives. For more information, see the document RFC 2616: Hypertext Transfer Protocol—HTTP/1.1, available on the World Wide Web Consortium's site at http://www.w3c.org. The System.Web.HttpCacheability enumeration value to set the header to. The cache control extension to add to the header.
SetETag
Sets the ETag HTTP header to the specified string.
The ETag header is a unique identifier for a specific version of a document. Once an ETag header is set, subsequent attempts to set it will fail and an exception will be thrown. The text to use for the ETag header.
SetETagFromFileDependencies
Sets the ETag HTTP header based on the time stamps of the handler's file dependencies.
SetEtagFromFileDependencies sets the ETag header by retrieving the last modified time stamps of all files on which the handler is dependent, combining all file names and time stamps into a single string, then hashing that string into a single digest that is used as the ETag.
SetExpires
Sets the Expires HTTP header to an absolute date and time.
This method will fail if the expiration date violates the principle of restrictiveness. The absolute System.DateTime value to set the Expiresheader to.
SetLastModified
Sets the Last-Modified HTTP header to the System.DateTime value supplied.
The Last-Modified HTTP header time stamps the document with the DateTime value indicating when the document was last modified. The new System.DateTime value for the Last-Modified header.
SetLastModifiedFromFileDependencies
Sets the Last-Modified HTTP header based on the time stamps of the handler's file dependencies.
SetMaxAge
Sets the Cache-Control: max-age HTTP header based on the specified time span.
Max-age is the maximum absolute time a document is allowed to exist before being considered stale. The time span used to set the Cache-Control: max-age header.
SetNoServerCaching
Stops all origin-server caching for the current response.
Explicitly denies caching of the document on the origin-server. Once set, all requests for the document are fully processed. When this method is invoked, caching cannot be reenabled for the current response.
SetNoStore
Sets the Cache-Control: no-store directive.
SetNoTransforms
Sets the CacheControl: no-transform directive.
The no-transform CacheControl setting instructs network caching applications to not modify the document.
SetProxyMaxAge
Sets the Cache-Control: s-maxage HTTP header based on the specified time span.
System.Web.HttpCachePolicy.SetProxyMaxAge(System.TimeSpan) does not use sliding expiration and will fail if the expiration date violates the principle of restrictiveness. The time span used to set the Cache-Control: s-maxage header.
SetRevalidation
Sets the Cache-Control HTTP header to either the must-revalidate or the proxy-revalidate directives based on the supplied enumeration value.
The default is to send neither directive in a header unless explicitly specified by this method. The System.Web.HttpCacheRevalidation enumeration value to set the Cache-Control header to.
SetSlidingExpiration
Sets cache expiration to sliding.
When cache expiration is set to sliding, the Cache-Control HTTP header will be renewed with each response. This expiration mode is identical to the IIS configuration option to add an expiration header to all output set relative to the current time. true or false.
SetValidUntilExpires
SetVaryByCustom
Sets the Vary HTTP header to the specified text string. The text to set the Vary header to.
HttpCacheRevalidation enumeration (System.Web)
ToString
Description
Provides enumerated values that are used to set revalidation-specific Cache-Control HTTP headers.
ToString
Sets the Cache-Control: must-revalidate HTTP header.
ToString
Default value. If this value is set, no cache-revalidation directive is sent.
ToString
Sets the Cache-Control: proxy-revalidate HTTP header.
HttpCacheValidateHandler delegate (System.Web)
ToString
Description
Delegate method that is called when a cached item is validated. Cache items invalidated within the method are treated as cache misses. The System.Web.HttpContext object containing information about the current request. User-supplied data used to validate the cached item. A System.Web.HttpValidationStatus enumeration value.
If any handler invalidates the cached item, the item is evicted from the cache and the request is handled as a cache miss.
HttpCacheVaryByHeaders class (System.Web)
ToString
Description
Provides a type-safe way to set the Vary HTTP header.
The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request.
AcceptTypes
ToString
Gets or sets a value indicating whether the origin server adds the Accept field to the Vary HTTP header.
The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The Accept field specifies that the server selects the response based on the media types acceptable to the client.
Item
ToString
Gets or sets a value indicating whether the origin server should add a custom field to the Vary HTTP header.
The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The name of the custom header.
UserAgent
ToString
Gets or sets a value indicating whether the origin server adds the User-Agent field to the Vary HTTP header.
The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The User-Agent field specifies that the server selects the response based on the type of client user-agent.
UserCharSet
ToString
Gets or sets a value indicating whether the origin server should add the Accept-Charset field to the Vary HTTP header.
The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The Accept-CharSet field specifies that the server selects the response based on the client's character set.
UserLanguage
ToString
Gets or sets a value indicating whether the origin server adds the Accept-Language field to the Vary HTTP header.
The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The Accept-Language field specifies that the server selects the response based on languages acceptable to the client.
VaryByUnspecifiedParameters
Sets the Vary HTTP header to the value * (an asterisk) and causes all other Vary header information to be dropped.
The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The * field specifies that the server selects the response based on parameters not specified in request headers (for example, the network address of the client).
HttpCacheVaryByParams class (System.Web)
VaryByUnspecifiedParameters
Description
Indicates that a cache should contain multiple representations (cached responses) for a particular URI. This class is an encapsulation that provides a type-safe way to set the Vary HTTP header.
For more information on HTTP cache control headers, see RFC 2616: Hypertext Transfer Protocol—HTTP/1.1, available on the World Wide Web Consortium's Web site at http://www.w3c.org. See section 14, “Header Field Definitions”, for complete details.
IgnoreParams
VaryByUnspecifiedParameters
Gets or sets a value indicating whether HTTP header cache control parameters are ignored.
Item
VaryByUnspecifiedParameters
Gets or sets the name of the cache-control header that is used to select one of several different cached responses. The name of the custom header.
HttpClientCertificate class (System.Web)
ToString
Description
The HttpClientCertificate collection retrieves the certification fields (specified in the X.509 standard) from a request issued by the Web browser.
AllKeys
BinaryIssuer
ToString
Description
CertEncoding
ToString
Certificate
ToString
A string containing the binary stream of the entire certificate content in ASN.1 format.
Cookie
ToString
Count
Flags
ToString
Description
A set of flags that provide additional client certificate information.
IsPresent
ToString
IsReadOnly
Issuer
ToString
Description
A string that contains a list of subfield values containing information about the certificate issuer.
IsValid
ToString
Item
Item
Keys
KeySize
ToString
Description
PublicKey
ToString
SecretKeySize
ToString
SerialNumber
ToString
A string that contains the certification serial number as an ASCII representation of hexadecimal bytes separated by hyphens (-). For example, 04-67-F3-02.
ServerIssuer
ToString
ServerSubject
ToString
Subject
ToString
A string that contains a list of subfield values that contain information about the subject of the certificate. If this value is specified without a SubField, the ClientCertificate collection returns a comma-separated list of subfields. For example, C=US, O=Msft, and so on.
ValidFrom
ToString
A date specifying when the certificate becomes valid. This date varies with international settings.
ValidUntil
ToString
A date specifying when the certificate expires. The year value is displayed as a four-digit number.
Get
Allows access to individual items in the collection by name. The name of the item in the collection to retrieve.
HttpCompileException class (System.Web)
ToString
Description
The exception that is thrown when a compiler error occurs.
HttpCompileException
Example Syntax:
ToString
Initializes a new instance of the System.Web.HttpCompileException class. A System.CodeDom.Compiler.CompilerResults containing compiler output and error information. The name of the file being compiled when the error occurs.
ErrorCode
HelpLink
HResult
InnerException
Message
Results
ToString
Description
Gets compiler output and error information for the exception.
Source
SourceCode
ToString
Description
Gets the name of the source file being compiled when the error occurs.
StackTrace
TargetSite
HttpContext class (System.Web)
ToString
Description
Encapsulates all HTTP-specific information about an individual HTTP request.
Classes that inherit the System.Web.IHttpModule and System.Web.IHttpHandler interfaces are provided a reference to an HttpContext object for the current HTTP request. The object provides access to the intrinsic System.Web.HttpContext.Request, System.Web.HttpContext.Response, and System.Web.HttpContext.Server objects for the request.
HttpContext
Example Syntax:
ToString
Initializes a new instance of the System.Web.HttpContext class. The System.Web.HttpWorkerRequest object for the current HTTP request.
HttpContext
Example Syntax:
ToString
Initializes a new instance of the System.Web.HttpContext class. The System.Web.HttpRequest object for the current HTTP request. The System.Web.HttpResponse object for the current HTTP request.
AllErrors
ToString
Gets an array of errors accumulated while processing an HTTP request.
Application
ToString
Gets the System.Web.HttpApplicationState object for the current HTTP request.
ApplicationInstance
ToString
Gets or sets the System.Web.HttpApplicationState object for the current HTTP request.
Cache
ToString
Gets the System.Web.Caching.Cache object for the current HTTP request.
Current
ToString
Gets the System.Web.HttpContext object for the current HTTP request.
Error
ToString
Gets the first error (if any) accumulated during HTTP request processing.
Handler
ToString
Gets or sets the System.Web.IHttpHandler object for the current HTTP request.
IsCustomErrorEnabled
ToString
Gets a value indicating whether custom errors are enabled for the current HTTP request.
IsDebuggingEnabled
ToString
Gets a value indicating whether the current HTTP request is in debug mode.
Items
ToString
Gets a key-value collection that can be used to organize and share data between an System.Web.IHttpModule and an System.Web.IHttpHandler during an HTTP request.
Request
ToString
Gets the System.Web.HttpRequest object for the current HTTP request.
Response
ToString
Gets the System.Web.HttpResponse object for the current HTTP response.
Server
ToString
Gets the System.Web.HttpServerUtility object that provides methods used in processing Web requests.
Session
ToString
Gets the System.Web.SessionState instance for the current HTTP request.
SkipAuthorization
ToString
Gets or sets a value that specifies whether the URLAuthorization module will skip the authorization check for the current request.
SkipAuthorization is for advanced use by authentication modules that need to redirect to an anonymous-allowed page. The Forms authentication module and Passport authentication module both set this property when redirecting to a configured login page. Setting this requires the ControlPrincipal flag to be set in System.Security.Permissions.SecurityPermission.Flags.
Timestamp
ToString
Gets the initial timestamp of the current HTTP request.
Trace
ToString
Gets the System.Web.TraceContext object for the current HTTP response.
User
ToString
Gets or sets security information for the current HTTP request.
Setting this property requires the ControlPrincipal flag to be set in System.Security.Permissions.SecurityPermission.Flags.
AddError
Adds an exception to the exception collection for the current HTTP request. The System.Exception object to add to the exception collection.
ClearError
Clears all errors for the current HTTP request.
GetAppConfig
Returns requested configuration information for the current application The application configuration tag that information is requested for.
GetConfig
Returns requested configuration information for the current HTTP request. The configuration tag that information is requested for.
RewritePath
Assigns an internal rewrite path. The internal rewrite path.
IServiceProvider.GetService
HttpCookie class (System.Web)
ToString
Description
Provides a type-safe way to create and manipulate individual HTTP cookies.
The System.Web.HttpCookie class gets and sets properties of individual cookies. The System.Web.HttpCookieCollection class provides methods to store, retrieve, and manage all the cookies for an entire Web application. ASP.NET code uses the intrinsic System.Web.HttpResponse.Cookies object to create cookies and add them to the cookie collection. When delivering a Web page to a client, the server sends the entire cookie collection with the Set-Cookie header.
HttpCookie
Example Syntax:
ToString
Creates and names a new cookie. The name of the new cookie.
HttpCookie
Example Syntax:
ToString
Creates, names, and assigns a value to a new cookie. The name of the new cookie. The value of the new cookie.
Domain
ToString
Gets or sets the domain to associate the cookie with.
Setting the Domain attribute limits transmission of the cookie to clients requesting a resource from that domain.
Expires
ToString
Gets or sets the expiration date and time for the cookie.
HasKeys
ToString
Gets a value indicating whether a cookie has subkeys.
Item
ToString
Shortcut for HttpCookie.Values[key]. This property is provided for compatibility with previous versions of ASP. Key (index) of cookie value.
Name
ToString
Gets or sets the name of a cookie.
Path
ToString
Gets or sets the virtual path to transmit with the current cookie.
The Path property extends the Domain property to completely describe the specific URL that the cookie applies to. For example, in the URL http:/www.microsoft.com/asp, the domain is www.microsoft.com and the path is /asp.
Secure
ToString
Gets or sets a value indicating whether to transmit the cookie securely (that is, over HTTPS only).
Value
ToString
Gets or sets an individual cookie value.
Values
ToString
Gets a collection of key-and-value value pairs that are contained within a single cookie object.
HttpCookieCollection class (System.Web)
ToString
Description
Provides a type-safe way to manipulate HTTP cookies.
HttpCookieCollection
Example Syntax:
ToString
Initializes a new instance of the System.Web.HttpCookieCollection class.
ASP.NET includes two intrinsic cookie collections. The collection accessible through System.Web.HttpRequest.Cookies contains cookies transmitted by the client to the server in the Cookie header. The collection accessible through System.Web.HttpResponse.Cookies contains cookies generated on the server and transmitted to the client in the Set-Cookie header.
AllKeys
ToString
Gets a string array containing all the keys (cookie names) in the cookie collection.
Count
IsReadOnly
Item
ToString
Description
Gets the cookie with the specified numerical index from the cookie collection. The index of the cookie to retrieve from the collection.
Item
ToString
Gets the cookie with the specified name from the cookie collection. Name of cookie to retrieve.
Keys
Add
Adds the specified cookie to the cookie collection.
Any number of cookie collections can exist within an application, but only the collection referenced by the intrinsic System.Web.HttpResponse.Cookies object is sent to the client. The System.Web.HttpCookie to add to the collection.
Clear
Clears all cookies from the cookie collection.
CopyTo
Copies members of the cookie collection to an System.Array beginning at the specified index of the array. The destination System.Array. The index of the destination array where copying starts.
Get
Returns the System.Web.HttpCookie item with the specified index from the cookie collection. The index of the cookie to return from the collection.
Get
Returns the System.Web.HttpCookie item with the specified name from the cookie collection.
If the named cookie does not exist, this method creates a new cookie with that name. The name of the cookie to retrieve from the collection.
GetKey
Returns the key (name) of the cookie at the specified numerical index. The index of the key to retrieve from the collection.
Remove
Removes the cookie with the specified name from the collection. The name of the cookie to remove from the collection.
Set
Updates the value of an existing cookie in a cookie collection. The System.Web.HttpCookie object to update.
HttpException class (System.Web)
ToString
Description
Provides a means of generating HTTP exceptions.
HttpException
Example Syntax:
ToString
Constructs an empty Exception object.
When handling exceptions, it is sometimes useful to capture a series of related exceptions with the outer exceptions being thrown in response to an inner exceptions.
HttpException
Example Syntax:
ToString
Constructs an System.Exception using a supplied error message. The message displayed to the client when the exception is thrown.
HttpException
Example Syntax:
ToString
Constructs an System.Exception using an HTTP error code and an error message. The HTTP error code displayed on the client. The message displayed to the client when the exception is thrown.
HttpException
Example Syntax:
ToString
Constructs an System.Exception using an error message and the System.Exception.InnerException property.
When handling exceptions, it is sometimes useful to capture a series of related exceptions with the outer exceptions being thrown in response to an inner exception. The message displayed to the client when the exception is thrown. The System.Exception.InnerException, if any, that threw the current exception.
HttpException
Example Syntax:
ToString
Constructs an System.Exception using error message and an exception code. The error message displayed to the client when the exception is thrown. The exception code that defines the error.
HttpException
Example Syntax:
ToString
Constructs an System.Exception using an HTTP error code, an error message, and the System.Exception.InnerException property.
When handling exceptions, it is sometimes useful to capture a series of related exceptions with the outer exceptions being thrown in response to an inner exceptions. The HTTP error code displayed to the client. The message displayed to the client. The InnerException, if any, that threw the current exception.
HttpException
Example Syntax:
ToString
Constructs an System.Exception using HTTP error code, an error message, and an exception code. The HTTP error code displayed on the client. The error message displayed to the client. The error code that defines the error.
ErrorCode
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
CreateFromLastError
Creates a new System.Exception based on the previous Exception.
Return Value: An Exception with the same error identification code as the previous Exception but with a new message. The message to be displayed to the client when the exception is thrown.
GetHtmlErrorMessage
Returns the HTTP error message to send back to the client.
Return Value: The HTTP error message.
GetHttpCode
Returns the HTTP error code to send back to the client. If there is a nonzero HTTP code, it is returned. Otherwise, the System.Exception.InnerException code is returned. If neither an InnerException code nor a nonzero HTTP code is available, the HTTP error code 500 is returned.
Return Value: The HTTP code representing the exception.
HttpFileCollection class (System.Web)
ToString
Description
Provides access to and organizes files uploaded by a client.
Clients encode files and transmit them in the content body using multipart MIME format with an HTTP Content-Type header of multipart/form-data. ASP.NET extracts the encoded file(s) from the content body into individual members of an System.Web.HttpFileCollection. Methods and properties of the System.Web.HttpPostedFile class provide access to the contents and properties of each file.
AllKeys
ToString
Gets a string array containing the keys (names) of all members in the file collection.
Count
IsReadOnly
Item
ToString
Description
Gets the object with the specified numerical index from the System.Web.HttpFileCollection. The index of the item to get from the file collection.
Item
ToString
Gets the object with the specified name from the file collection. Name of item to be returned.
Keys
CopyTo
Copies members of the file collection to an System.Array beginning at the specified index of the array. The destination System.Array. The index of the destination array where copying starts.
Get
Returns the System.Web.HttpPostedFile object with the specified numerical index from the file collection. The index of the object to be returned from the file collection.
Get
Returns the System.Web.HttpPostedFile object with the specified name from the file collection. The name of the object to be returned from a file collection.
GetKey
Returns the name of the System.Web.HttpFileCollection member with the specified numerical index. The index of the object name to be returned.
HttpModuleCollection class (System.Web)
ToString
Description
Provides a means of indexing and retrieving a collection of System.Web.IHttpModule objects.
AllKeys
ToString
Gets a string array containing all the keys (module names) in the System.Web.HttpModuleCollection.
Count
IsReadOnly
Item
ToString
Description
Gets the System.Web.IHttpModule object with the specified numerical index from the System.Web.HttpModuleCollection. The index of the System.Web.IHttpModule object to retrieve from the collection.
Item
ToString
Gets the System.Web.IHttpModule object with the specified name from the System.Web.HttpModuleCollection. Key of the item to be retrieved.
Keys
CopyTo
Copies members of the module collection to an System.Array beginning at the specified index of the array. The destination Array. The index of the destination Array where copying starts.
Get
Returns the System.Web.IHttpModule object with the specified index from the System.Web.HttpModuleCollection. Index of the System.Web.IHttpModule object to return from the collection.
Get
Returns the System.Web.IHttpModule object with the specified name from the System.Web.HttpModuleCollection. Key of the item to be retrieved.
GetKey
Returns the key (name) of the System.Web.IHttpModule object at the specified numerical index. Index of the key to retrieve from the collection.
HttpParseException class (System.Web)
ToString
Description
The exception that is thrown when a parse error occurs.
HttpParseException
Example Syntax:
ToString
Initializes a new instance of the System.Web.HttpParseException class. The message displayed to the client when the exception is thrown. The System.Exception, if any, that threw the current exception. The name of the file being parsed when the error occurs. The number of the line being parsed when the error occurs.
ErrorCode
FileName
ToString
Description
Gets the name of the file being parsed when the error occurs.
HelpLink
HResult
InnerException
Line
ToString
Description
Gets the number of the line being parsed when the error occurs.
Message
Source
StackTrace
TargetSite
HttpPostedFile class (System.Web)
ToString
Description
Provides a way to access individual files that have been uploaded by a client.
The System.Web.HttpFileCollection class provides access to all the files uploaded from a client as a file collection.
ContentLength
ToString
Gets the size in bytes of an uploaded file.
ContentType
ToString
Gets the MIME content type of a file sent by a client.
FileName
ToString
Gets the fully-qualified name of the file on the client's machine (for example “C:\MyFiles\Test.txt”).
InputStream
ToString
Gets a System.IO.Stream object which points to an uploaded file to prepare for reading the contents of the file.
SaveAs
Saves an uploaded MIME message body to a file on the server. The name of the file.
HttpRequest class (System.Web)
ToString
Description
Enables ASP.NET to read the HTTP values sent by a client during a Web request.
HttpRequest
Example Syntax:
ToString
Initializes an System.Web.HttpRequest object. The name of the file associated with the request. Information regarding the URL of the current request. The entire query string sent with the request (everything after the ‘?’).
AcceptTypes
ToString
Gets a string array of client-supported MIME accept types.
ApplicationPath
ToString
Gets the ASP.NET application's virtual application root path on the server.
Browser
ToString
Gets information about the requesting client's browser capabilities.
ClientCertificate
ToString
Gets the current request's client security certificate.
ContentEncoding
ToString
Gets the character set of the entity-body.
Default ContentEncoding can be specified in an ASP.NET configuration file. If ContentEncoding is specified by the client, the default configuration settings are overridden.
ContentLength
ToString
Specifies the length, in bytes, of content sent by the client.
ContentType
ToString
Gets the MIME content type of the incoming request.
Cookies
ToString
Gets a collection of cookies sent by the client.
ASP.NET includes two intrinsic cookie collections. The collection accessed through System.Web.HttpRequest.Cookies contains cookies transmitted by the client to the server in the Cookie header. The collection accessed through System.Web.HttpResponse.Cookies contains cookies generated on the server and transmitted to the client in the Set-Cookie header.
CurrentExecutionFilePath
ToString
FilePath
ToString
Gets the virtual path of the current request.
The System.Web.HttpRequest.FilePath does not include the System.Web.HttpRequest.PathInfo trailer. For the URL Http://www.microsoft.com/virdir/page.html/tail, the FilePath is Http://www.microsoft.com/virdir/page.html.
Files
ToString
Gets the collection of client-uploaded files (Multipart MIME format).
The file collection is populated only when the HTTP request Content-Type is multipart/form-data.
Filter
ToString
Gets or sets the filter to use when reading the current input stream.
Form
ToString
Gets a collection of form variables.
Populated when the HTTP request Content-Type is either application/x-www-form-urlencoded or multipart/form-data.
Headers
ToString
Gets a collection of HTTP headers.
HttpMethod
ToString
Gets the HTTP data transfer method (such as GET, POST, or HEAD) used by the client.
InputStream
ToString
Gets the contents of the incoming HTTP entity body.
IsAuthenticated
ToString
Gets a value indicating whether the user has been authenticated.
IsSecureConnection
ToString
Gets a value indicting whether the HTTP connection uses secure sockets (that is, HTTPS).
Item
ToString
Default HttpRequest indexed property that retrieves a QueryString, Form, Cookies, or ServerVariables collection. This property is read-only. Numerical index to collection members.
Params
ToString
Gets a combined collection of System.Web.HttpRequest.QueryString, System.Web.HttpRequest.Form, System.Web.HttpRequest.ServerVariables, and System.Web.HttpRequest.Cookies items.
Path
ToString
Gets the virtual path of the current request.
The System.Web.HttpRequest.FilePath does not include the System.Web.HttpRequest.PathInfo trailer. For the URL Http://www.microsoft.com/virdir/page.html/tail, the FilePath is Http://www.microsoft.com/virdir/page.html.
PathInfo
ToString
Gets additional path information for a resource with a URL extension.
For the URL Http://www.microsoft.com/virdir/page.html/tail, the PathInfo value is /tail.
PhysicalApplicationPath
ToString
Gets the physical file system path of the currently executing server application's root directory.
PhysicalPath
ToString
Gets the physical file system path corresponding to the requested URL.
QueryString
ToString
Gets the collection of HTTP query string variables.
RawUrl
ToString
Gets the raw URL of the current request.
The raw URL is defined as the part of the URL following the domain information. In the URL string http://www.microsoft.com/articles/recent.aspx, the raw URL is /articles/recent.aspx. The raw URL includes the query string, if present.
RequestType
ToString
Gets or sets the HTTP data transfer method (GET or POST) used by the client.
ServerVariables
ToString
Gets a collection of web server variables.
TotalBytes
ToString
Gets the number of bytes in the current input stream.
Url
ToString
Gets Information about the URL of the current request.
UrlReferrer
ToString
Gets information about the URL of the client's previous request that linked to the current URL.
UserAgent
ToString
Gets the raw user agent string of the client browser.
UserHostAddress
ToString
Gets the IP host address of the remote client.
UserHostName
ToString
Gets the DNS name of the remote client.
UserLanguages
ToString
Gets a sorted string array of client language preferences.
BinaryRead
Performs a binary read of a specified number of bytes from the current input stream.
Return Value: A byte array.
The BinaryRead method is provided for compatibility with previous versions of ASP. Number of bytes to read.
MapImageCoordinates
Maps an incoming image-field form parameter to appropriate x/y coordinate values.
Return Value: A two-dimensional array of integers. A string reference to a form image map.
MapPath
Maps the specified virtual path to a physical path. The virtual path (absolute or relative) for the current request.
MapPath
Maps the specified virtual path to a physical path. The virtual path (absolute or relative) for the current request. The virtual base directory path used for relative resolution. If true, the virtualPath may belong to another application.
SaveAs
Saves an HTTP request to disk.
Saving the request context to disk can be useful in debugging. A string reference to a physical drive path. A Boolean value specifying whether an HTTP header should be saved to disk.
HttpResponse class (System.Web)
ToString
Description
Encapsulates HTTP response information from an ASP.NET operation.
The methods and properties of the HttpResponse class are exposed through ASP.NET's intrinsic Response object.
HttpResponse
Example Syntax:
ToString
Initializes a new instance of the HttpResponse class. A TextWriter object enabling custom HTTP output.
Buffer
ToString
Gets or sets a value indicating whether to buffer output and send it after the entire response is finished processing.
System.Web.HttpResponse.Buffer has been deprecated in favor of System.Web.HttpResponse.BufferOutput and is provided only for compatibility with previous versions of ASP. With ASP.NET, use System.Web.HttpResponse.BufferOutput.
BufferOutput
ToString
Gets or sets a value indicating whether to buffer output and send it after the entire page is finished processing.
Cache
ToString
Gets the caching policy (expiration time, privacy, vary clauses) of a Web page.
CacheControl
ToString
Sets the Cache-Control HTTP header to Public or Private.
The values for Private and Public are strings and must be enclosed in quotation marks (“ ”).
Charset
ToString
Gets or sets the HTTP character set of the output stream.
Charset can be set to null to suppress the Content-Type header.
ContentEncoding
ToString
Gets or sets the HTTP character set of the output stream.
ContentType
ToString
Gets or sets the HTTP MIME type of the output stream.
The following example takes action if the content type of the output is not “Text/HTML”.
Cookies
ToString
Gets the response cookie collection.
ASP.NET includes two intrinsic cookie collections. The collection accessed through Cookies contains cookies transmitted by the client to the server in the System.Web.HttpRequest.Cookies header. The collection accessed through System.Web.HttpResponse.Cookies contains cookies generated on the server and transmitted to the client in the Set-Cookie header.
Expires
ToString
Gets or sets the number of minutes before a page cached on a browser expires. If the user returns to the same page before it expires, the cached version is displayed.
The Expires, System.Web.HttpResponse.ExpiresAbsolute and System.Web.HttpResponse.CacheControl properties have been deprecated in favor of the methods of the System.Web.HttpCachePolicy class available through the System.Web.HttpResponse.Cache intrinsic object to control the IIS output cache and client caches.
ExpiresAbsolute
ToString
Gets or sets the absolute date and time at which to remove cached information from the cache.
The ExpiresAbsolute, System.Web.HttpResponse.Expires and System.Web.HttpResponse.CacheControl properties have been deprecated in favor of the methods of the System.Web.HttpCachePolicy class available through the System.Web.HttpResponse.Cache intrinsic object to control the IIS output cache and client caches.
Filter
ToString
Gets or sets a wrapping filter object used to modify the HTTP entity body before transmission.
When you create a Stream object and set the Response.Filter property to the Stream object, all HTTP output sent by Response.Write passes through the filter.
IsClientConnected
ToString
Gets a value indicating whether the client is still connected to the server.
Output
ToString
Enables output of text to the outgoing HTTP response stream.
OutputStream
ToString
Enables binary output to the outgoing HTTP content body.
Status
ToString
Sets the Status line that is returned to the client.
System.Web.HttpResponse.Status has been deprecated in favor of System.Web.HttpResponse.StatusDescription and is provided only for compatibility with previous versions of ASP. With ASP.NET, use System.Web.HttpResponse.StatusDescription instead.
StatusCode
ToString
Gets or sets the HTTP status code of the output returned to the client.
StatusDescription
ToString
Gets or sets the HTTP status string of the output returned to the client.
SuppressContent
ToString
Gets or sets a value indicating whether to send HTTP content to the client.
AddCacheItemDependencies
AddCacheItemDependency
AddFileDependencies
Adds a group of file names to the collection of file names on which the current response is dependent. The collection of files to add.
AddFileDependency
Adds a single file name to the collection of file names on which the current response is dependent. The name of the file to add.
AddHeader
Adds an HTTP header to the output stream.
AddHeader is the same as System.Web.HttpResponse.AppendHeader(System.Web.HttpResponseHeader) and is provided only for compatibility with previous versions of ASP. With ASP.NET, use AppendHeader. The name of the HTTP header to add value to. The string to add to the header.
AppendCookie
Adds an HTTP cookie to the intrinsic cookie collection. The cookie to add to the output stream.
AppendHeader
Adds an HTTP header to the output stream.
If you use the System.Web.HttpResponse.AppendHeader(System.Web.HttpResponseHeader) method to send cache-specific headers and at the same time use the cache object model ( System.Web.HttpResponse.Cache ) to set cache policy, HTTP response headers pertaining to caching (Cache-Control, Expires, Last-Modified, Pragma, and Vary) might be deleted when the cache object model is used. This behavior enables ASP.NET to maintain the most restrictive settings. For example, consider a page that includes user controls. If those controls have conflicting cache policies, the most restrictive cache policy will be used. If one user control sets the header “Cache-Control: Public” and another sets the more restrictive header “Cache-Control: Private” via calls to System.Web.HttpCachePolicy.SetCacheability(System.Web.HttpCacheability), then the “Cache-Control: Private” header will be sent with the response. The name of the HTTP header to add to the output stream. The string to append to the header.
AppendToLog
Adds custom log information to the IIS log file. The text to add to the log file.
ApplyAppPathModifier
BinaryWrite
Writes a string of binary characters to the HTTP output stream. The bytes to write to the output stream.
Clear
Clears all content output from the buffer stream.
ClearContent
Clears all content output from the buffer stream.
ClearHeaders
Clears all headers from the buffer stream.
Close
Closes the socket connection to a client.
End
Sends all currently buffered output to the client, stops execution of the page, and fires the Application_EndRequest event.
Flush
Sends all currently buffered output to the client.
Forces all currently buffered output to be sent to the client.
Pics
Appends a PICS-Label HTTP header to the output stream.
Platform for Internet Content Selection (PICS) is a World Wide Web Consortium (W3C) standard for content labeling. PICS is essentially a language for creating a ratings system. The string to add to the PICS-Label header.
Redirect
Redirects a client to a new URL. The target location.
Redirect
RemoveOutputCacheItem
SetCookie
Updates an existing cookie in the cookie collection.
Write
Writes a character to an HTTP output content stream. The character to write to the HTTP output stream.
Write
Writes an Object to an HTTP output content stream. The Object to write to the HTTP output stream.
Write
Writes a string to an HTTP output content stream. The string to write to the HTTP output stream.
Write
Writes an array of characters to an HTTP output content stream. The character array to write. The position in the character array where writing starts. The number of characters to write, beginning at index.
WriteFile
Writes the specified file directly to an HTTP content output stream. The name of the file to write to the HTTP output.
WriteFile
Writes the contents of the specified file into a memory block. The name of the file to write into a memory block. Indicates whether the file will be written into a memory block.
WriteFile
Writes the specified file directly to an HTTP content output stream. The file handle of the file to write to the HTTP output stream. The byte position in the file where writing will start. The number of bytes to write to the output stream.
WriteFile
Writes the specified file directly to an HTTP content output stream. The name of the file to write to the HTTP output stream. The byte position in the file where writing will start. The number of bytes to write to the output stream.
HttpRuntime class (System.Web)
WriteFile
Description
Provides a set of ASP.NET runtime services.
HttpRuntime
Example Syntax:
WriteFile
AppDomainAppId
WriteFile
AppDomainAppPath
WriteFile
AppDomainAppVirtualPath
WriteFile
AppDomainId
WriteFile
AspInstallDirectory
WriteFile
BinDirectory
WriteFile
Cache
WriteFile
Provides access to the cache.
ClrInstallDirectory
WriteFile
CodegenDir
WriteFile
IsOnUNCShare
WriteFile
MachineConfigurationDirectory
WriteFile
Close
Removes all items from the cache and shuts down the runtime.
ProcessRequest
The method that drives all ASP.NET Web processing execution. HttpWorkerRequest object
HttpServerUtility class (System.Web)
ToString
Description
Provides helper methods for processing Web requests.
The methods and properties of the System.Web.HttpServerUtility class are exposed through ASP.NET's intrinsic System.Web.HttpContext.Server object.
MachineName
ToString
Gets the server machine name.
ScriptTimeout
ToString
Gets and sets the request time-out in seconds.
ClearError
Clears the previous exception.
CreateObject
Creates a server instance of a COM object identified by the object's Programmatic Identifier (ProgID).
Return Value: The new object. The class or type of object to be instantiated.
CreateObject
Instantiates a classic COM object identified via a Type.
CreateObjectFromClsid
Creates a server instance of a COM object identified by the object's class identifier (CLSID).
Return Value: The new object. The class identifier of the object to be instantiated.
Execute
Executes a request to another page using the specified URL path to the page.
The System.Web.HttpServerUtility.Execute(System.String) method continues execution of the original page after execution of the new page is completed. The System.Web.HttpServerUtility.Transfer(System.String,System.Boolean) method unconditionally transfers execution to another page. The URL path of the new request.
Execute
Executes a request to another page using the specified URL path to the page. A System.IO.TextWriter captures output from the page.
The System.Web.HttpServerUtility.Execute(System.String) method continues execution of the original page after execution of the new page is completed. The System.Web.HttpServerUtility.Transfer(System.String,System.Boolean) method unconditionally transfers execution to another page. The URL path of the new request. The System.IO.TextWriter to capture the output.
GetLastError
Returns the previous exception.
Return Value: The previous exception that was thrown.
HtmlDecode
Decodes an HTML-encoded string and returns the decoded string.
Return Value: The decoded text.
URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot cannot be used in ASP.NET pages in “ ” tags or in querystrings where the strings may be sent by a browser in a request string. The HTML string to decode.
HtmlDecode
Decodes an HTML-encoded string and sends the resulting output to a System.IO.TextWriter output stream.
URL encoding ensures that all browsers will correctly transmit text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “ ” tags or in querystrings where the strings may be sent by a browser in a request string. The HTML string to decode. The System.IO.TextWriter output stream containing the decoded string.
HtmlEncode
HTML-encodes a string and returns the encoded string.
Return Value: The HTML-encoded text.
URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “ ” tags or in querystrings where the strings may be sent by a browser in a request string. The text string to encode.
HtmlEncode
HTML-encodes a string and sends the resulting output to a System.IO.TextWriter output stream.
HTML encoding ensures that text will be correctly displayed in the browser, not interpreted by the browser as HTML. For example, if a text string contains “<” or “>” characters, the browser would interpret these characters as part of HTML tags. The HTML encoding of these two characters is “<” and “>”, respectively, which causes the browser to display the angle brackets correctly. The string to encode. The System.IO.TextWriter output stream containing the encoded string.
MapPath
Returns the physical file path that corresponds to the specified virtual path on the Web server.
Return Value: The physical file path that corresponds to path. The virtual path on the Web server.
Transfer
Terminates execution of the current page and begins execution of a new page using the specified URL path to the page. The URL path of the new page on the server to execute.
Transfer
Terminates execution of the current page and begins execution of a new page using the specified URL path to the page. Specifies whether to clear the System.Web.HttpRequest.QueryString and System.Web.HttpRequest.Form collections. The URL path of the new page on the server to execute. If true, the QueryString and Form collections are preserved. If false, they are cleared. The default is false.
UrlDecode
URL-decodes a string and returns the decoded string.
Return Value: The decoded text.
URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “ ” tags or in querystrings where the strings may be sent by a browser in a request string. The text string to decode.
UrlDecode
Decodes an HTML string received in a URL and sends the resulting output to a System.IO.TextWriter output stream. URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “ ” tags or in querystrings where the strings may be sent by a browser in a request string. The HTML string to decode. The System.IO.TextWriter output stream containing the decoded string.
UrlEncode
URL-encodes a string and returns the encoded string.
Return Value: The URL encoded text.
URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “ ” tags or in querystrings where the strings may be sent by a browser in a request string. The text to URL-encode.
UrlEncode
URL encodes a string and sends the resulting output to a TextWriter output stream.
URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “ ” tags or in querystrings where the strings may be sent by a browser in a request string. The text string to encode. The System.IO.TextWriter output stream containing the encoded string.
UrlPathEncode
URL-encodes the path portion of a URL string and returns the encoded string.
Return Value: The URL encoded text.
URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot cannot be used in ASP.NET pages in “ ” tags or in querystrings where the strings may be sent by a browser in a request string. The text to URL-encode.
HttpStaticObjectsCollection class (System.Web)
UrlPathEncode
Description
Provides a static objects collection for the System.Web.HttpApplicationState.StaticObjects property.
HttpStaticObjectsCollection
Example Syntax:
UrlPathEncode
Count
UrlPathEncode
Gets the number of objects in the collection.
IsReadOnly
UrlPathEncode
Gets a value indicating whether the collection is read-only.
IsSynchronized
UrlPathEncode
Gets a value indicating whether the collection is synchronized (i.e.: thread-safe).
Item
UrlPathEncode
Gets the object with the specified name from the collection. The case-insensitive name of the object to get.
SyncRoot
UrlPathEncode
Gets an object that can be used to synchronize access to the collection.
Program code should generally perform synchronized operations on the SyncRoot of a collection, not directly on the collection itself. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection object.
CopyTo
Copies members of an HttpStaticObjectsCollection into an array. The array to copy the HttpStaticObjectsCollection into. The member of the collection where copying starts.
GetEnumerator
Returns a dictionary enumerator used for iterating through the key-and-value pairs contained in the collection.
Return Value: The enumerator for the collection.
GetObject
Returns the object with the specified name from the collection. This property is an alternative to the this accessor.
Return Value: An object from the collection. The case-insensitive name of the object to return.
HttpUnhandledException class (System.Web)
ToString
Description
The exception that is thrown when a generic exception occurs.
HttpUnhandledException
Example Syntax:
ToString
Initializes a new instance of the System.Web.HttpUnhandledException class with the specified error message and inner exception. The message displayed to the client when the exception is thrown. The System.Exception.InnerException, if any, that threw the current exception.
HttpUnhandledException
Example Syntax:
ToString
Initializes a new instance of the HttpUnhandledException class with the specified error messages and inner exception. The message displayed to the client when the exception is thrown. An additional message displayed to the client when the exception is thrown. The System.Exception.InnerException, if any, that threw the current exception.
ErrorCode
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
HttpUtility class (System.Web)
ToString
Description
Provides methods for encoding and decoding URLs when processing Web requests.
HttpUtility
Example Syntax:
ToString
HtmlAttributeEncode
Minimally converts a string to an HTML-encoded string.
Return Value: The encoded string.
HtmlAttributeEncode converts only quotes (“) and ampersands (&) to equivalent character entities. It is considerably faster than the System.Web.HttpUtility.HtmlEncode(System.String) methods. The string to encode.
HtmlAttributeEncode
Minimally converts a string into an HTML-encoded string and sends the encoded string to a System.IO.TextWriter output stream.
HtmlAttributeEncode converts only quotes (“) and ampersands (&) to equivalent character entities. It is considerably faster than the System.Web.HttpUtility.HtmlEncode(System.String) methods. The string to encode A System.IO.TextWriter output stream.
HtmlDecode
Converts a string that has been HTML-encoded for HTTP transmission into a decoded string.
Return Value: The decoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. HTML encoding converts characters that are not allowed in HTML into character-entity equivalents; HTML decoding reverses the encoding. For example, when embedded in a block of text, the characters < and >, are encoded as < and > for HTTP transmission. The string to decode.
HtmlDecode
Converts a string that has been HTML-encoded into a decoded string, and sends the decoded string to a System.IO.TextWriter output stream.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. HTML encoding converts characters that are not allowed in HTML into character-entity equivalents; HTML decoding reverses the encoding. For example, when embedded in a block of text, the characters < and >, are encoded as < and > for HTTP transmission. The string to decode. A System.IO.TextWriter stream of output.
HtmlEncode
Converts a string to an HTML-encoded string for reliable HTTP transmission from the Web server to a client.
Return Value: The encoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. HTML encoding converts characters that are not allowed in HTML into character-entity equivalents; HTML decoding reverses the encoding. For example, when embedded in a block of text, the characters < and >, are encoded as < and > for HTTP transmission. The string to encode.
HtmlEncode
Converts a string into an HTML-encoded string, and returns the output as a TextWriter stream of output.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. HTML encoding converts characters that are not allowed in HTML into character-entity equivalents; HTML decoding reverses the encoding. For example, when embedded in a block of text, the characters < and >, are encoded as < and > for HTTP transmission. The string to encode A System.IO.TextWriter output stream.
UrlDecode
Converts a string that has been encoded for transmission in a URL into a decoded string.
Return Value; The decoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The string to decode.
UrlDecode
Converts a URL-encoded byte array into a decoded string, using the specified decoding method.
Return Value: The decoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The byte array to decode. The System.Text.Encoding that specifies the decoding method.
UrlDecode
Converts a URL-encoded string into a decoded string, using the specified decoding method.
Return Value: The decoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The string to decode. The System.Text.Encoding that specifies the decoding method.
UrlDecode
Converts a URL-encoded byte array into a decoded string, using the specified decoding method, starting at the specified position in the array, and continuing for the specified number of bytes.
Return Value: The decoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The array of bytes to decode. The position in the byte to begin decoding. The number of bytes to decode starting at offset. The System.Text.Encoding object that specifies the decoding method.
UrlDecodeToBytes
Converts a URL-encoded arrray of bytes into a decoded array of bytes.
Return Value: The decoded array of bytes.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The array of bytes to decode.
UrlDecodeToBytes
Converts a URL-encoded string into a decoded array of bytes.
Return Value: The decoded array of bytes.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The string to decode.
UrlDecodeToBytes
Converts a URL-encoded string into a decoded array of bytes, using the specified decoding method.
Return Value: The decoded array of bytes.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The string to decode. The System.Text.Encoding object that specifies the decoding method.
UrlDecodeToBytes
Converts a URL-encoded arrray of bytes into a decoded array of bytes, starting at the specified position in the array and continuing for the specified number of bytes.
Return Value: The decoded array of bytes.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The array of bytes to decode. The position in the byte array to begin decoding. The number of bytes to decode, starting at offset.
UrlEncode
Converts a byte array into an encoded URL string for reliable HTTP transmission from the Web server to a client.
Return Value: The encoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The byte array to encode.
UrlEncode
Encodes a URL string for reliable HTTP transmission from the Web server to a client.
Return Value: The encoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The text to encode.
UrlEncode
Encodes a URL string for reliable HTTP transmission from the Web server to a client, using the specified encoding method.
Return Value: The encoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The text to encode. The System.Text.Encoding object that specifies the encoding scheme.
UrlEncode
Converts a byte array into a URL-encoded string for reliable HTTP transmission from the Web server to a client, starting at the specified position in the array and continuing for the specified number of bytes.
Return Value: The encoded string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The byte array to encode. The position in the byte array to begin encoding. The number of bytes to encode, starting at offset.
UrlEncodeToBytes
Converts an array of bytes into a URL-encoded array of bytes.
Return Value: The encoded array of bytes.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The array of bytes to encode.
UrlEncodeToBytes
Converts a string into a URL-encoded array of bytes Return Value: The encoded array of bytes.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The string to encode.
UrlEncodeToBytes
Converts a string into a URL-encoded array of bytes, using the specified encoding method.
Return Value: The encoded array of bytes.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The string to encode The System.Text.Encoding that specifies the encoding method.
UrlEncodeToBytes
Converts an array of bytes into a URL-encoded array of bytes, starting at the specified position in the array and continuing for the specified number of bytes.
Return Value: The encoded array of bytes.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The array of bytes to encode. The position in the byte array to begin encoding. The number of bytes to encode, starting at offset.
UrlEncodeUnicode
Converts a string into a Unicode string.
Return Value: The Unicode string.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not legal in a URL to character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The string to convert.
UrlEncodeUnicodeToBytes
Converts a string into a Unicode array of bytes.
Return Value: The Unicode byte array.
If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not legal in a URL to character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3d. The string to convert.
HttpValidationStatus enumeration (System.Web)
UrlEncodeUnicodeToBytes
Description
Provides enumerated values that indicate cache validation status.
UrlEncodeUnicodeToBytes
Specifies not to validate the entity in the cache.
UrlEncodeUnicodeToBytes
Indicates that the cache is invalid.
UrlEncodeUnicodeToBytes
Indicates that the cache is valid.
HttpWorkerRequest class (System.Web)
ToString
Description
This abstract class defines the base worker methods and enumerations used by ASP.NET managed code for request processing.
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
[C#] public const int HeaderReferer;
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
ToString
HttpWorkerRequest
Example Syntax:
ToString
MachineConfigPath
ToString
MachineInstalIDirectory
ToString
CloseConnection
EndOfRequest
FlushResponse
GetAppPath
When overridden in a derived class, returns the virtual path to the currently executing server application.
Return Value: The virtual path of the current application.
GetAppPathTranslated
When overridden in a derived class, returns the UNC-translated path to the currently executing server application.
Return Value: The UNC physical path of the current application.
GetAppPoolID
When overridden in a derived class, returns the application pool ID for the current URL.
Return Value: Always returns null.
GetBytesRead
GetClientCertificate
Defines the base worker class used by ASP.NET managed code for request processing.
GetClientCertificateBinaryIssuer
GetClientCertificateEncoding
GetClientCertificatePublicKey
GetClientCertificateValidFrom
GetClientCertificateValidUntil
When overridden in a derived class, returns the ID of the current connection.
Return Value: Always returns 0.
GetFilePath
When overridden in a derived class, returns the physical path to the requested URI.
Return Value: The path to the URI.
GetFilePathTranslated
When overridden in a derived class, returns the translated file path to the requested URI (from virtual path to UNC path, ie “/proj1/page.aspx” to “c:\dir\page.aspx”)
Return Value: The translated file path.
GetHttpVerbName
Provides access to the specified member of the request header.
Return Value: The HTTP verb returned in the request header.
GetHttpVersion
Provides access to the specified member of the request header.
Return Value: The HTTP version returned in the request header.
GetKnownRequestHeader
GetKnownRequestHeaderIndex
GetKnownRequestHeaderName
GetKnownResponseHeaderIndex
GetKnownResponseHeaderName
GetLocalAddress
Provides access to the specified member of the request header.
Return Value: The server's IP address returned in the request header.
GetLocalPort
Provides access to the specified member of the request header.
Return Value: The server's port number returned in the request header.
GetPathInfo
When overridden in a derived class, returns additional path information for a resource with a URL extension. That is, for the URL /virdir/page.html/tail, the PathInfo value is /tail.
Return Value: Additional path information for a resource.
GetPreloadedEntityBody
GetProtocol
When overridden in a derived class, returns the HTTP protocol (HTTP or HTTPS).
Return Value: HTTPS if IsSecure is true, otherwise false.
GetQueryString [C#] public abstract string GetQueryString( );
Provides access to the specified member of the request header.
Return Value: The QueryString member of the request header.
GetQueryStringRawBytes
When overridden in a derived class, returns the response query string as an array of bytes.
Return Value: An array of bytes containing the response.
GetRawUrl
Provides access to the specified member of the request header.
Return Value: The raw url member of the request header.
GetRemoteAddress
Provides access to the specified member of the request header.
Return Value: The client's IP address returned in the request header.
GetRemoteName
When overridden in a derived class, returns the client computer's name.
Return Value: The name of the client machine.
GetRemotePort
Provides access to the specified member of the request header.
Return Value: The client HTTP port number returned in the request header.
GetRequestReason
When overridden in a derived class, returns the reason for the request. Return Value: Reason code. The default is ReasonResponseCacheMiss.
GetServerName
When overridden in a derived class, returns the name of the local server.
Return Value: The name of the server.
GetServerVariable
GetStatusDescription
GetUnknownRequestHeader
GetUnknownRequestHeaders
GetUriPath
Returns the physical path to the requested URI.
Return Value: The path of the requested URI.
GetUrlContextID
When overridden in a derived class, returns the context ID of the current connection.
Return Value: Always returns 0.
GetUserToken
When overridden in a derived class, returns the client's impersonation token.
Return Value: The value representing the impersonation token. The default is 0.
GetVirtualPathToken
HasEntityBody
HeadersSent
IsClientConnected
IsEntireEntityBodyIsPreloaded
IsSecure
When overridden in a derived class, returns a value indicating whether the connection is secure (using SSL).
Return Value: true if the connection is secure, otherwise false. The default is false.
MapPath
ReadEntityBody
SendCalculatedContentLength
SendKnownResponseHeader
SendResponseFromFile
SendResponseFromFile
SendResponseFromMemory
SendResponseFromMemory
SendStatus
SendUnknownResponseHeader
SetEndOfSendNotification
HttpWriter class (System.Web)
ToString
Description
Provides a System.IO.TextWriter object that is accessed through the intrinsic System.Web.HttpResponse object.
The System.Web.HttpResponse.Write(System.String) methods of the intrinsic System.Web.HttpResponse object make internal calls to an HttpWriter object.
Encoding
ToString
Description
Gets an System.Text.Encoding object for the System.IO.TextWriter.
FormatProvider
NewLine
OutputStream
ToString
Description
Gets a System.IO.Stream object to enable HTTP output directly from the Stream
Close
Sends all buffered output to the HTTP output stream and closes the socket connection.
Flush
Sends all buffered output to the HTTP output stream.
Write
Sends a single character to the HTTP output stream. The character to send to the HTTP output stream.
Write
Sends an Object to the HTTP output stream. The Object to send to the HTTP output stream.
Write
Sends a string to the HTTP output stream. The string to send to the HTTP output stream.
Write
Sends a stream of characters with the specified starting position and number of characters to the HTTP output stream. The memory buffer containing the characters to send to the HTTP output stream The buffer position of the first character to send. The number of characters to send beginning at the position specified by index.
WriteBytes
Sends a stream of bytes with the specified starting position and number of bytes to the HTTP output stream. The memory buffer containing the bytes to send to the HTTP output stream. The buffer position of the first byte to send. The number of bytes to send, beginning at the byte position specified by index.
WriteLine
Sends a carriage return +line feed (CRLF) pair of characters to the HTTP output stream.
WriteString
Sends a string or a sub-string to the client.
IHttpAsyncHandler interface (System.Web) WriteString
Description
When implemented by a class, defines the contract that HTTP asynchronous handler objects must implement.
BeginProcessRequest
[C#] IAsyncResult BeginProcessRequest(HttpContext context, AsyncCallback cb, object extraData);
Initiates an asynchronous call to the HTTP handler. Return Value: An System.IAsyncResult that contains information about the status of the process. An System.Web.HttpContext object that provides references to intrinsic server objects (for example, Request, Response, Session, and Server) used to service HTTP requests. The System.AsyncCallback to call when the asynchronous method call is complete. If cb is a null reference (Nothing in Visual Basic), the delegate is not called. Any extra data needed to process the request.
EndProcessRequest
Executes clean-up code when the process ends. An System.IAsyncResult that contains information about the status of the process.
IHttpHandler interface (System.Web) EndProcessRequest
Description
Defines the contract that ASP.NET implements to synchronously process HTTP Web requests using custom HTTP handlers.
You can write custom HTTP handlers to process specific, predefined types of HTTP requests in any Common Language Specification (CLS) compliant language. Executable code defined in the HttpHandler classes, rather than conventional ASP or ASP.NET Web pages, responds to these specific requests. HTTP handlers give you a means of interacting with the low-level request and response services of the IIS Web server and provide functionality much like ISAPI extensions but with a simpler programming model.
IsReusable
EndProcessRequest
Gets a value indicating whether another request can use the System.Web.IIHttpHandler instance.
You explicitly set the IsReusable property to true or false by code you provide that overrides the IsReusable property accessor.
ProcessRequest
Enables processing of HTTP Web requests by a custom HttpHandler that implements the System.Web.IIHttpHandler interface.
Place your custom HttpHandler code in the ProcessRequest virtual method as shown in the following example. An System.Web.HttpContext object that provides references to the intrinsic server objects (for example, Request, Response, Session, and Server) used to service HTTP requests.
IHttpHandlerFactory interface (System.Web)
ProcessRequest
Description
Defines the contract that class factories must implement to create new System.Web.IIHttpHandler objects.
A class that implements the IHttpHandlerFactory interface has no behavior except to dynamically manufacture new handler objects—that is, new instances of classes that implement the IHttpHandler interface.
GetHandler
Returns an instance of a class that implements the IHttpHandler interface. Return Value: A new IHttpHandler object that processes the request. An instance of the System.Web.HttpContext class that provides references to intrinsic server objects (For example, Request, Response, Session, and Server) used to service HTTP requests. The HTTP data transfer method (GET or POST) that the client uses. The System.Web.HttpRequest.RawUrl of the requested resource. The System.Web.HttpRequest.PhysicalApplicationPath to the requested resource.
ReleaseHandler
Enables a factory to reuse an existing handler instance. The IHttpHandler object to reuse.
IHttpModule interface (System.Web)
ReleaseHandler
Description
Provides module initialization and disposal events to the inheriting class.
Dispose
Disposes of the resources (other than memory) used by the module that implements IHttpModule.
Dispose performs any final cleanup work prior to removal of the module from the execution pipeline.
Init
Initializes a module and prepares it to handle requests.
ProcessInfo class (System.Web)
Init
Description
Provides information on processes currently executing.
ProcessInfo
Example Syntax:
Init
Initializes a new instance of the System.Web.ProcessInfo class.
The default constructor initializes all fields to their default values.
ProcessInfo
Example Syntax:
Init
Initializes a new instance of the ProcessInfo class and sets internal information indicating the status of the process. A System.DateTime that indicates the time at which the process started. The System.TimeSpan that indicates the time elapsed since the process started. The ID number assigned to the process. The number of start requests for the process. One of the System.Web.ProcessStatus values that indicates the current status of the process. One of the System.Web.ProcessShutdownReason values. The maximum memory used (in bytes).
Age
Init
Gets the length of time the process has been running.
PeakMemoryUsed
Init
Gets the maximum amount of memory the process has used.
ProcessID
Init
Gets the ID number assigned to the process.
RequestCount
Init
Gets the number of start requests for the process.
ShutdownReason
Init
Gets a value that indicates why the process shut down.
StartTime
Init
Gets the time at which the process started.
Status
Init
Gets the current status of the process.
SetAll
Sets internal information indicating the status of the process. A System.DateTime that indicates the time at which the process started. A System.TimeSpan that indicates the time elapsed since the process started. The ID number assigned to the process. The number of start requests for the process. One of the System.Web.ProcessStatus values that indicates the time elapsed since tha process started. One of the System.Web.ProcessShutdownReason values. The maximum memory used (in bytes).
ProcessModelInfo class (System.Web)
ToString
ProcessModelInfo
Example Syntax:
ToString
GetCurrentProcessInfo
GetHistory
ProcessShutdownReason enumeration (System.Web)
ToString
Description
Provides enumerated values that indicate why a process has shut down.
ToString
Indicates that the process exceeded the allowable idle time.
ToString
Indicates that the process exceeded the per-process memory limit.
ToString
Indicates that the process has not shut down.
ToString
ToString
Indicates that the request for a process exceeded the allowable number of processes in the queue.
ToString
Indicates that the request for the process exceeded the allowable number of processes.
ToString
Indicates that the process timed out.
ToString
Indicates that the process shut down unexpectedly.
ProcessStatus enumeration (System.Web)
ToString
Description
Provides enumerated values that indicate the current status of a process.
ToString
Indicates that the process is running.
ToString
Indicates that the process has shut down.
ToString
Indicates that the process has begun to shut down.
ToString
Indicates that the process has terminated.
TraceContext class (System.Web)
ToString
Description
Captures and presents execution details about a Web request. This class cannot be inherited.
You can use this class to append messages to specific trace categories. For example, if you are creating an instance of the System.Web.UI.WebControls.Calendar class for your application, you might include the trace message “Starting To Render” in a rendering procedure, and “Firing OnChange Event” in an event handling procedure.
TraceContext
Example Syntax:
ToString
Initializes a new instance of the System.Web.TraceContext class. An System.Web.HttpContext that contains information about the current Web request.
IsEnabled
ToString
Indicates whether tracing is enabled for the current Web request.
Use this flag to check whether your page or application should output tracing information before it writes anything to the trace log. You can set this property to true for a page by including a trace=“true” attribute in the directive. To set the property to true for an entire application, set it in the application's Web.config file.
TraceMode
ToString
Gets or sets the sorted order in which trace messages should be output to a requesting browser.
Trace messages can be sorted in the order they were processed, or alphabetically by user-defined category.
Warn
Writes a trace message to the trace log. All warnings appear as in the log as red text. The trace message to write to the log.
Warn
Writes trace information to the trace log, including any user-defined categories and trace messages. All warnings appear in the log as red text. The trace category that receives the message. The trace message to write to the log.
Warn
Writes trace information to the trace log, including any user-defined categories,trace messages, and error information. All warnings appear in the log as red text. The trace category that receives the message. The trace message to write to the log. An System.Exception that contains information about the error.
Write
Writes a trace message to the trace log. The trace message to write to the log.
Write
Writes trace information to the trace log, including a message and any user-defined categories. The trace category that receives the message. The trace message to write to the log.
Write
Writes trace information to the trace log, including any user-defined categories,trace messages, and error information. The trace category that receives the message. The trace message to write to the log. An System.Exception that contains information about the error.
TraceMode enumeration (System.Web)
Write
Description
Specifies in what order trace messages are emitted into the HTML output of a page.
Write
Specifies the default value of the TraceMode enumeration, which is SortByTime.
System.Web.Caching
Description
The System.Web.Caching namespace provides classes for caching frequently used resources on the server. This includes ASP.NET pages, web services, and user controls. Additionally, a cache dictionary is available for you to store frequently used resources, such as hashtables and other data structures.
Cache class (System.Web.Caching)
Description
Implements the cache for a Web application.
One instance of this class is created per application domain, and it remains valid as long as the application domain remains active. Information about an instance of this class is available through the Cache property of the System.Web.HttpContext object. This class cannot be inherited.
Used in the absoluteExpiration parameter in an System.Web.Caching.Cache.Insert(System.String,System.Object) method call to indicate the item should never expire. This field is read-only.
When used, this field sets the absoluteExpiration parameter equal to System.DateTime.MaxValue, which is a constant representing the largest possible DateTime value, 12/31/9999 11:59:59 PM.
Used as the slidingExpiration parameter in an System.Web.Caching.Cache.Insert(System.String,System.Object) method call to disable sliding expirations. This field is read-only.
When used, this field sets the slidingExpiration parameter equal to the System.TimeSpan.Zero field, which has a constant value of zero. The cached item then expires in accordance with the absoluteExpiration parameter.
Constructors:
Cache
Example Syntax:
Properties:
Count
Gets the number of items stored in the cache.
This property can be useful when monitoring your application's performance or when using ASP.NET tracing functionality.
Item
Gets or sets the cache item at the specified key.
You can use this property to retrieve the value of a specified cache item, or to add an item and a key for it to the cache. A System.String object that represents the key for the cache item.
Methods:
Add
Adds the specified item to the System.Web.Caching.Cache object with dependencies, expiration and priority policies, and a delegate you can use to notify your application when the inserted item is removed from the Cache. Return Value: The System.Object item added to the Cache. The cache key used to reference the item. The item to be added to the cache. The file or cache key dependencies for the item. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this paramter contains null. The time at which the added object expires and is removed from the cache. The interval between the time the added object was last accessed and when that object expires. If this value is the equivalent of 20 minutes, the object expires and is removed from the cache 20 minutes after it is last accessed. The relative cost of the object, as expressed by the System.Web.Caching.CacheItemPriority enumeration. The cache uses this value when it evicts objects; objects with a lower cost are removed from the cache before objects with a higher cost. A delegate that, if provided, is called when an object is removed from the cache. You can use this to notify applications when their objects are deleted from the cache.
Get
Retrieves the specified item from the System.Web.Caching.Cache object.
Return Value: The retrieved cache item, or null if the key is not found. The identifier for the cache item to retrieve.
GetEnumerator
Retrieves a dictionary enumerator used to iterate through the key settings and their values contained in the cache.
Return Value: An enumerator to iterate through the System.Web.Caching.Cache object.
Items can be added or removed from the cache while this method is enumerating through the items.
Insert
Inserts an item into the System.Web.Caching.Cache object with a cache key to reference its location and using default values provided by the System.Web.Caching.CacheItemPriority and System.Web.Caching.CacheItemPriorityDecay enumerations. The cache key used to reference the item. The object to be inserted into the cache.
Insert
Inserts an object into the System.Web.Caching.Cache that has file or key dependencies. The cache key used to identify the item. The object to be inserted in the cache. The file or cache key dependencies for the inserted object. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this parameter contains null.
Insert
Inserts an object into the System.Web.Caching.Cache with dependencies and expiration policies.
If the slidingExpiration parameter is set to NoSlidingExpiration, sliding expiration is disabled. If you set the slidingExpiration parameter to greater than System.TimeSpan.Zero, the absoluteExpiration parameter is set to System.DateTime.Now plus the value contained in the slidingExpiration parameter. If the item is requested from the cache before the amount of time specified by the absoluteExpiration parameter, the item will be placed in the cache again, and absoluteExpiration will again be set to DateTime.Now plus the value contained in the slidingExpiration parameter. If the item is not requested from the cache before the date in the absoluteExpiration parameter, the item is removed from the cache. The cache key used to reference the object. The object to be inserted in the cache. The file or cache key dependencies for the inserted object. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this parameter contains null. The time at which the inserted object expires and is removed from the cache. The interval between the time the inserted object is last accessed and when that object expires. If this value is the equivalent of 20 minutes, the object will expire and be removed from the cache 20 minutes after it was last accessed.
Insert
Inserts an object into the System.Web.Caching.Cache object with dependencies, expiration and priority policies, and a delegate you can use to notify your application when the inserted item is removed from the Cache. The cache key used to reference the object. The object to be inserted in the cache. The file or cache key dependencies for the item. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this parameter contains null. The time at which the inserted object expires and is removed from the cache. The interval between the time the inserted object was last accessed and when that object expires. If this value is the equivalent of 20 minutes, the object will expire and be removed from the cache 20 minutes after it was last accessed. The cost of the object relative to other items stored in the cache, as expressed by the System.Web.Caching.CacheItemPriority enumeration. This value is used by the cache when it evicts objects; objects with a lower cost are removed from the cache before objects with a higher cost. A delegate that, if provided, will be called when an object is removed from the cache. You can use this to notify applications when their objects are deleted from the cache.
Remove
Removes the specified item from the application's System.Web.Caching.Cache object.
Return Value: The item removed from the Cache. If the value in the key parameter is not found, returns null. A System.String identifier for the cache item to remove.
IEnumerable.GetEnumerator
CacheDependency class (System.Web.Caching)
ToString
Description
Tracks cache dependencies, which can be files, directories, or keys to other objects in your application's System.Web.Caching.Cache. This class cannot be inherited.
You can add items with dependencies to your application's cache with the System.Web.Caching.Cache.Add(System.String,System.Object,System.Web. Caching.CacheDependency,System.DateTime,System.TimeSpan,System.Web. Caching.CacheItemPriority,System.Web.Caching.CacheItemRemovedCallback) and System.Web.Caching.Cache.Insert(System.String,System.Object) methods.
CacheDependency
Example Syntax:
ToString
Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors a file or directory for changes. The path to a file or directory that the cached object is dependent upon. When this resource changes, the cached object becomes obsolete and is removed from the cache.
CacheDependency
Example Syntax:
ToString
Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories) for changes.
If any of the files or directories in the array were to change or be removed from the array, the cached item becomes obsolete and is removed from the application's System.Web.Caching.Cache object. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache.
CacheDependency
Example Syntax:
ToString
Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors a file or directory for changes and indicates when change tracking is to begin. The path to a file or directory that the cached object is dependent upon. When this resource changes, the cached object becomes obsolete and is removed from the cache. The time when change tracking begins.
CacheDependency
Example Syntax:
ToString
Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories) for changes and specifies a time when change monitoring begins. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. The time when change tracking begins.
CacheDependency
Example Syntax:
ToString
Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories), an array of cache keys, or both for changes. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. An array of cache keys that the new object monitors for changes. When any of these cache keys change, the cached object associated with this dependency object becomes obsolete and is removed from the cache.
CacheDependency
Example Syntax:
ToString
Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories), an array of cache keys, or both for changes. It also makes itself dependent upon a separate instance of the CacheDependency class. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. An array of cache keys that the new object monitors for changes. When any of these cache keys change, the cached object associated with this dependency object becomes obsolete and is removed from the cache. Another instance of the CacheDependency class that this instance is dependent upon.
CacheDependency
Example Syntax:
ToString
Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories), an array of cache keys, or both for changes. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. An array of cache keys that the new object monitors for changes. When any of these cache keys change, the cached object associated with this dependency object becomes obsolete and is removed from the cache. The time when change tracking begins.
CacheDependency
Example Syntax:
ToString
Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories), an array of cache keys, or both for changes. It also makes itself dependent upon another instance of the CacheDependency class and a time when the change monitoring begins. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. An array of cache keys that the new object monitors for changes. When any of these cache keys change, the cached object associated with this dependency object becomes obsolete and is removed from the cache. Another instance of the CacheDependency class that this instance is dependent upon. The time when change tracking begins.
Dispose
Releases the resources used by the System.Web.Caching.CacheDependency object.
CacheItemPriority enumeration (System.Web.Caching)
ToString
Description
Specifies the relative priority of items stored in the System.Web.Caching.Cache.
When the Web server hosting an ASP.NET application runs low on memory, the Cache selectively purges items to free system memory. When an item is added to the cache, you can assign it a relative priority compared to the other items stored in the cache. Items you assign higher priority values to are less likely to be deleted from the cache when the server is processing a large number of requests, while items you assign lower priority values are more likely to be deleted. The default is Normal.
ToString
Cache items with this priority level are less likely to be deleted as the server frees system memory than those assigned a Normal priority.
ToString
Cache items with this priority level are more likely to be deleted from the cache as the server frees system memory than items assigned a Normal priority.
ToString
The default value for a cached item's priority is Normal.
ToString
Cache items with this priority level are the least likely to be deleted from the cache as the server frees system memory.
ToString
Cache items with this priority level are the most likely to be deleted from the cache as the server frees system memory.
ToString
Cache items with this priority level are likely to be deleted from the cache as the server frees system memory only after those items with Low or BelowNormal priority. This is the default.
ToString
The cache items with this priority level will not be deleted from the cache as the server frees system memory.
CacheItemRemovedCallback delegate (System.Web.Caching)
ToString
Description
Defines a callback method for notifying applications when a cached item is removed from the System.Web.Caching.Cache. The index location for the item removed from the cache. The System.Object item removed from the cache. The reason the item was removed from the cache, as specified by the System.Web.Caching.CacheItemRemovedReason enumeration.
CacheItemRemovedReason enumeration (System.Web.Caching)
ToString
Description
Specifies the reason an item was removed from the System.Web.Caching.Cache.
This enumeration works in concert with the System.Web.Caching.CacheItemRemovedCallback delegate to notify your ASP.NET applications when and why an object was removed from the System.Web.Caching.Cache.
ToString
The item is removed from the cache because a file or key dependency changed.
ToString
The item is removed from the cache because it expired.
ToString
The item is removed fro
System.Web.Configuration
Description
The System.Web.Configuration namespace contains classes that are used to set up ASP.NET configuration.
AuthenticationMode enumeration (System.Web.Configuration)
Description
Provides enumerated values that specify the authentication mode for an application.
Specifies ASP.NET forms-based authentication as the default authentication mode.
Specifies no authentication. Only anonymous users are expected. Also, applications can handle events to provide their own authentication.
Specifies Microsoft Passport authentication as the default authentication mode.
Specifies Windows authentication as the default authentication mode. Use this mode when using any form of Internet Information Services (IIS) authentication: Basic, Digest, Integrated Windows authentication (NTLM/Kerberos), or certificates.
Methods:
ClientTargetSectionHandler class (System.Web.Configuration)
ToString
Description
Constructors:
ClientTargetSectionHandler
Example Syntax:
ToString
Properties:
KeyAttributeName
ToString
Gets the name of the key attribute tag. This property is overidden by derived classes to change the name of the key attribute tag. The default is “key”.
ValueAttributeName
ToString
Gets the name of the value tag. This property may be overidden by derived classes to change the name of the value tag. The default is “value”.
FormsAuthPasswordFormat enumeration (System.Web.Configuration)
ToString
Description
Provides enumerated values that specify the encryption format for storing passwords.
ToString
Specifies that passwords are not encrypted.
ToString
Specifies that passwords are encrypted using the MD5 hash algorithm.
ToString
Specifies that passwords are encrypted using the SHA1 hash algorithm.
FormsProtectionEnum enumeration (System.Web.Configuration)
ToString
Description
Provides enumerated values that are used to specify the forms protection method.
ToString
Specifies that the application uses both data validation and encryption to protect the cookie. This option uses the configured data validation algorithm (based on the element). Triple-DES (3DES) is used for encryption, if it is available and if the key is at least 48 bytes longs.
ToString
Specifies that the cookie is encrypted using Triple-DES or DES, but data validation is not performed on the cookie. Cookies used this way might be subject to plain-text security attacks.
ToString
Specifies that both encryption and validation are disabled for sites that are using cookies only for personalization and have weaker security requirements. Using cookies in this manner is not recommended; however, it is the least resource-intensive way to enable personalization using the NET Framework.
ToString
Specifies that the application uses a validation scheme to verify that the contents of an encrypted cookie have not been altered in transit. The cookie is created by concatenating a validation key with the cookie data, computing a Message Authentication Code (MAC), and appending the MAC to the outgoing cookie.
HttpCapabilitiesBase class (System.Web.Configuration)
ToString
Description
Defines the base class for client browser capabilities.
HttpCapabilitiesBase
Example Syntax:
ToString
Item
ToString
Allows access to individual dictionary values. The name of the dictionary value to retrieve.
GetConfigCapabilities
Returns individual browser capabilities for the current reqest. The name of the requested browser capability. The current System.Web.HttpContext.Request
Init
AppDomainFactory class (System.Web.Hosting)
Description
Constructors:
AppDomainFactory
Example Syntax:
Methods:
Create
ApplicationHost class (System.Web.Hosting)
ToString
Description
CreateApplicationHost
IAppDomainFactory interface (System.Web.Hosting)
ToString
Description
Create
IISAPIRuntime interface (System.Web.Hosting)
Create
Description
DoGCCollect
ProcessRequest
StartProcessing
StopProcessing
ISAPIRuntime class (System.Web.Hosting)
StopProcessing
Description
ISAPIRuntime
Example Syntax:
StopProcessing
DoGCCollect
ProcessRequest
StartProcessing
StopProcessing
SimpleWorkerRequest class (System.Web.Hosting)
ToString
Description
SimpleWorkerRequest
Example Syntax:
ToString
SimpleWorkerRequest
Example Syntax:
ToString
MachineConfigPath
ToString
MachineInstallDirectory
ToString
EndOfRequest
FlushResponse
GetAppPath
GetAppPathTranslated
GetFilePath
GetFilePathTranslated
GetHttpVerbName
GetHttpVersion
GetLocalAddress
GetLocalPort
GetPathInfo
GetQueryString
GetRawUrl
GetRemoteAddress
GetRemotePort
GetServerVariable
GetUriPath
GetUserToken
MapPath
SendKnownResponseHeader
SendResponseFromFile
SendResponseFromFile
SendResponseFromMemory
SendStatus
Description
The System.Web.Mail namespace contains classes that enable you to construct and send an email attachment using the SMTP mail service built into Microsoft Windows 2000.
MailAttachment class (System.Web.Mail)
Description
Provides properties and methods to construct an email attachment.
Constructors:
MailAttachment
Example Syntax:
Constructs a MailAttachment object and specifies the file name of the attachment. Sets the System.Text.Encoding property to be UUEncode by default. Name of the attached file.
MailAttachment
Example Syntax:
Constructs an email attachment object and specifies the file name and encoding of the attachment. Name of the attached file. The type of System.Web.Mail.MailEncoding used by the attachment.
Properties:
Encoding
Indicates the type of encoding used to encode the email attachment.
Filename
Indicates the name of the file to attach to the email.
Methods:
MailEncoding enumeration (System.Web.Mail)
ToString
Description
Provides enumered values for email encoding.
ToString
Specifies that the email message uses Base64 encoding.
ToString
Specifies that the email message uses UUEncode encoding.
MailFormat enumeration (System.Web.Mail)
ToString
Description
Provides enumerated values for email format.
ToString
Specifies that email format is HTML.
ToString
Specifies that email format is plain text.
MailMessage class (System.Web.Mail)
ToString
Description
Provides properties and methods to construct an email message.
MailMessage
Example Syntax:
ToString
Attachments
ToString
Specifies the list of attachments that is transmitted with the message.
Bcc
ToString
Gets or sets a semicolon-delimited list of email addresses that receive a Blind Carbon Copy (BCC) copy of the email message.
The primary and carbon copy System.Web.Mail.MailMessage.Cc recipients do not see addresses included in the Bcc field.
Body
ToString
Gets or sets the body of the email message.
BodyEncoding
ToString
Gets or sets the encoding type of the email body.
BodyFormat
ToString
Gets or sets the content type of the email body.
Cc
ToString
Gets or sets a semicolon-delimited list of email addresses that receive a Carbon Copy (CC) of the email message.
From
ToString
Gets or sets the email address of the sender.
Headers
ToString
Specifies the custom headers that are transmitted with the email message.
Priority
ToString
Gets or sets the priority of the email message.
Subject
ToString
Gets or sets the subject line of the email message.
To
ToString
Gets or sets the email address of the recipient.
UrlContentBase
ToString
Gets or sets the URL base of all relative URLs used within the HTML encoded body.
UrlContentLocation
ToString
MailPriority enumeration (System.Web.Mail)
ToString
Description
Provides enumerated values for email priority.
ToString
Specifies that the email message has high priority.
ToString
Specifies that the email message has low priority.
ToString
Specifies that the email message has normal priority.
SmtpMail class (System.Web.Mail)
ToString
Description
Provides properties and methods to send an email attachment using the SMTP mail service built into Microsoft Windows 2000.
Mail is by default queued on a Windows 2000 system, ensuring that the calling program does not block network traffic.
SmtpMail
Example Syntax:
ToString
SmtpServer
ToString
Gets or sets the name of the SMTP mail server to use to send email messages.
Send
Sends a mail message using arguments supplied in the MailMessage properties. The System.Web.Mail.MailMessage object to send.
Send
Sends a mail message using the supplied destination arguments. The address of the email's sender. The address of the email's recipient. The subject line of the email message.
System.Web.Security
Description
This namespace contains classes that are used to implement ASP.NET security in Web server applications.
DefaultAuthenticationEventArgs class (System.Web.Security)
Description
Provides a wrapper around the default authentication services. This class cannot be inherited.
For more information about handling events, see.
Constructors:
DefaultAuthenticationEventArgs
Example Syntax:
Initializes a new instance of the System.Web.Security.DefaultAuthenticationEventArgs class. The context for the event.
Properties:
Context
The HttpContext intrinsic provides access to Request, Response, and User objects.
Methods:
DefaultAuthenticationEventHandler delegate (System.Web.Security)
ToString
Description
Represents the method that handles the DefaultAuthentication_OnAuthenticate event of a DefaultAuthenticationModule. The object that raised the event. A DefaultAuthenticationEventArgs object that contains the event data.
When you create a System.Web.Security.DefaultAuthenticationEventHandler delegate, you identify the method to handle the event. To associate the event with your EventHandler, add an instance of the delegate to the event. The EventHandler is called whenever the event occurs, unless you remove the delegate. For more information about EventHandler delegates, see.
DefaultAuthenticationModule class (System.Web.Security)
ToString
Description
Insures that an Authentication object is present in the context. This class cannot be inherited.
DefaultAuthenticationModule
Example Syntax:
ToString
ToString
Defines the event raised by the DefaultAuthentication module. Used by the DefaultAuthentication_OnAuthenticate handler, if one exists.
When you create a System.Web.Security.DefaultAuthenticationModule delegate, you identify the method to handle the event. To associate the event with your EventHandler, add an instance of the delegate to the event. The EventHandler is called whenever the event occurs, unless you remove the delegate. For more information about EventHandler delegates, see.
Dispose
Called by the HTTP runtime to Dispose of the module (derived from IHttpModule).
Call System.Web.Security.DefaultAuthenticationModule.Dispose when you are finished using the System.Web.Security.DefaultAuthenticationModule. The System.Web.Security.DefaultAuthenticationModule.Dispose method leaves the System.Web.Security.DefaultAuthenticationModule in an unusable state. After calling System.Web.Security.DefaultAuthenticationModule.Dispose, you must release all references to the System.Web.Security.DefaultAuthenticationModule so the memory occupied can be reclaimed by garbage collection.
Init
Initializes the module. The HTTP application.
FileAuthorizationModule class (System.Web.Security)
ToString
Description
Verifies that the remote user has NT permissions to access the file requested. This class cannot be inherited.
This module provides authorization services against file system ACLs. When the Windows authentication module is being used for the application, this module ensures (if in the pipeline) that the requesting user is allowed read access to the resource before executing it.
FileAuthorizationModule
Example Syntax:
ToString
Dispose
Disposes of the module dervied from IHttpModule when called by the HttpRuntime.
Call System.Web.Security.FileAuthorizationModule.Dispose when you are finished using the System.Web.Security.FileAuthorizationModule. The System.Web.Security.FileAuthorizationModule.Dispose method leaves the System.Web.Security.FileAuthorizationModule in an unusable state. After calling System.Web.Security.FileAuthorizationModule.Dispose, you must release all references to the System.Web.Security.FileAuthorizationModule so the memory occupied can be reclaimed by garbage collection.
Init
Initializes the module. The HttpApplication module.
FormsAuthentication class (System.Web.Security)
ToString
Description
Provides static methods that supply helper utilities for manipulating authentication tickets. This class cannot be inherited.
FormsAuthentication
Example Syntax:
ToString
FormsCookieName
ToString
Returns the configured cookie name used for the current application.
Returns a String.
FormsCookiePath
ToString
Returns the configured cookie path used for the current application.
Authenticate
Attempts to validate the credentials against those contained in the configured credential store, given the supplied credentials.
Return Value: Returns true if the credentials are valid, otherwise returns false. The user name The user password.
Decrypt
Returns an instance of a FormsAuthenticationTicket class, given an encrypted authentication ticket obtained from an HTTP cookie.
Return Value: Returns a FormsAuthenticationTicket object.
Encrypt
Produces a string containing an encrypted authentication ticket suitable for use in an HTTP cookie, given a FormsAuthenticationTicket.
Return Value: Returns a String containing an encrypted authentication ticket. An authentication ticket class.
GetAuthCookie
Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response, so that an application can have more control over how the cookie is issued.
Return Value: Returns an HttpCookie. Name of the authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (a cookie that is saved across browser sessions) should be issued. Cookie path defaults to‘/’.
GetAuthCookie
Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response, so that an application can have more control over how the cookie is issued.
Return Value: Returns an HttpCookie. Name of the authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (a cookie that is saved across browser sessions) should be issued. Specifies cookie path.
GetRedirectUrl
Returns the redirect URL for the original request that caused the redirect to the logon page.
Return Value: Returns a String.
If there is no original URL, Default.aspx is used. If the redirect URL specifies a different server, this method also returns the authentication ticket as part of the query string. This method can be used by applications that need to do the redirect themselves instead of using RedirectFromLoginPage. Name of the authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (a cookie that is saved across browser sessions) should be issued. Cookie path defaults to‘/’.
HashPasswordForStoringInConfigFile
Given a password and a string identifying the hash type, this routine produces a hash password suitable for storing in a configuration file.
Return Value: Returns a String containing a hashed password.
Password algorithms supported are SHA1 and MD5. The pasword to hash. The hash algorithm to use. Choices are “sha1” or “md5”.
Initialize
Initializes FormsAuthentication by reading the configuration and getting the cookie values and encryption keys for the given application.
RedirectFromLoginPage
Redirects an authenticated user back to the originally requested URL.
Redirects, based on the contents of the ReturnURL key in the query string, or redirects to Default.aspx if the return key does not exist. It issues an authentication ticket and does a SetForms with the ticket, using the appropriately configured cookie name for the application as part of the redirect response. Name of the user for cookie authentication purposes. This does not need to map to an account name and will be used by URL Authorization. Specifies whether or not a durable cookie (one that is saved across browser sessions) should be issued.
RedirectFromLoginPage
Redirects an authenticated user back to the originally requested URL.
Redirects, based on the contents of the ReturnURL key in the query string, or redirects to Default.aspx if the return key does not exist. It issues an authentication ticket and does a SetForms with the ticket, using the appropriately configured cookie name for the application as part of the redirect response. Name of the user for cookie authentication purposes. This does not need to map to an account name and will be used by URL Authorization. Specifies whether or not a durable cookie (one that is saved across browser sessions) should be issued. Specifies cookie path.
RenewTicketIfOld
Conditionally updates the sliding expiration on a FormsAuthenticationTicket.
Return Value: Returns the updated FormsAuthenticationTicket.
The ticket is updated with the IssueDate set to the current time and the expiration based on the difference between the previous expiration time and issue time. The test used to determine whether the ticket should be updated is (DateTime.Now â“ IssueDate)>(Expiration â
“ DateTime.Now).
SetAuthCookie
Creates an authentication ticket for the given userName and createPersistentCookie and attaches it to the cookie's collection of the outgoing response. It does not perform a redirect.
This has the effect of creating an authenticated user. Applications can use this when they intend to manually redirect, or if they do not want to redirect. For example, you can use this for an embedded logon area on a page. The name of an authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (one that is saved across browser sessions) should be issued.
SetAuthCookie
Creates an authentication ticket for the given userName,createPersistentCookie, and strCookiePath and attaches it to the cookie's collection of the outgoing response. It does not perform a redirect.
This has the effect of creating an authenticated user. Applications can use this when they intend to manually redirect, or if they do not want to redirect. For example, you can use this for an embedded logon area on a page. The name of an authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (one that is saved across browser sessions) should be issued. Specifies cookie path.
SignOut
Removes the authentication ticket by doing a SetForms with an empty value, given an authenticated user. This removes either durable or session cookies.
FormsAuthenticationEventArgs class (System.Web.Security)
ToString
Description
Provides data for the FormsAuthentication_OnAuthenticate event. This class cannot be inherited.
For more information about handling events, see.
FormsAuthenticationEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.Web.Security.FormsAuthenticationEventArgs class.
The following table shows initial property values for an instance of System.Web.Security.FormsAuthenticationEventArgs. The context for the event.
Context
ToString
Provides access to Request, Response, and User objects. This is the HttpContext intrinsic.
See the ASP.NET HttpRuntime documentation for more information.
User
ToString
Indicates the IPrincipal object to be associated with the request.
The user object will be attached to the context. If User is non null and Context.User is null, the FormsAuthenticationModule will initialize Context.User with FormsAuthenticationEventArgs.User.
FormsAuthenticationEventHandler delegate (System.Web.Security)
ToString
Description
Represents the method that will handle the FormsAuthentication event of a FormsAuthenticationModule. The source of the event. A System.Web.Security.FormsAuthenticationEventArgs that contains the event data.
When you create a System.Web.Security.FormsAuthenticationEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see This delegate defines the signature for the FormsAuthentication_OnAuthenticate event handler.
FormsAuthenticationModule class (System.Web.Security)
ToString
Description
Enables ASP.NET applications to use forms authentication. This class cannot be inherited.
FormsAuthenticationModule
Example Syntax:
ToString
ToString
Defines the event raised during authentication. This is a Global.asax event that must be named FormsAuthentication_OnAuthenticate. You can use this event to customize cookie authentication.
For more information about handling events, see.
Dispose
Disposes of the module derived from IHttpModule when called by the HttpRuntime.
Call System.Web.Security.FormsAuthenticationModule.Dispose when you are finished using the System.Web.Security.FormsAuthenticationModule. The System.Web.Security.FormsAuthenticationModule.Dispose method leaves the System.Web.Security.FormsAuthenticationModule in an unusable state. After calling System.Web.Security.FormsAuthenticationModule.Dispose, you must release all references to the System.Web.Security.FormsAuthenticationModule so the memory it was occupying can be reclaimed by garbage collection.
Init
Initializes the module derived from IHttpModule when called by the HttpRuntime. The HttpApplication module.
OnEnter
Called by the HttpRuntime. The source of the event. A System.Web.Security.FormsAuthenticationEventArgsthat contains the event data.
OnLeave
Called by the HttpRuntime. The source of the event. A System.Web.Security.FormsAuthenticationEventArgsthat contains the event data.
FormsAuthenticationTicket class (System.Web.Security)
ToString
Description
Provides the information represented in an authentication cookie as used by FormsAuthenticationModule. This class cannot be inherited.
For more information about using attributes, see.
FormsAuthenticationTicket
Example Syntax:
ToString
Creates a FormsAuthenticationTicket instance with the specified name and cookie durability, and default values for the other settings (version set internally, dates set to current date, and expiration determined on durability of cookie).
The default settings include version number, dates that are set to the current date, and expiration as determined by the durability setting. User name associated with the ticket. If true, use a persistent cookie. Specifies the time in minutes (as an integer) for which the authentication ticket is valid.
FormsAuthenticationTicket
Example Syntax:
ToString
Creates a FormsAuthenticationTicket instance with explicit values. The version number. User name associated with the ticket. Time at which the cookie was issued. Set an expiration date for the cookie. True if the cookie is persistent. User-defined data to be stored in the cookie.
FormsAuthenticationTicket
Example Syntax:
ToString
Creates a FormsAuthenticationTicket instance with explicit values. The version number. User name associated with the ticket. Time at which the cookie was issued. Set an expiration date for the cookie. True if the cookie is persistent. User-defined data to be stored in the cookie. THe path for the cookie.
CookiePath
ToString
Returns the Path for which the cookie was issued.
This is used when the cookie is refreshed.
Expiration
ToString
Returns the date/time at which the cookie expires.
For durable cookies, this should be the maximum value. For session scoped cookies, this should be set to the time the cookie was issued. This can be used by custom application logic to implement more-advanced expiration semantics.
Expired
ToString
Returns True if the cookie has expired.
IsPersistent
ToString
Returns True if a durable cookie was issued. Otherwise, the authentication cookie is scoped to the browser lifetime.
IssueDate
ToString
Returns the date/time at which the cookie was originally issued. This can be used for custom expiration schemes.
Name
ToString
Returns the user name associated with the authentication cookie.
This string is used for authorization purposes.
UserData
ToString
Returns an application-defined string that might have been stored in the cookie.
This field will be empty (“ ”) if no application-defined data was provided.
Version
ToString
Returns a byte version number for future use.
The current version identifier is 1.
FormsIdentity class (System.Web.Security)
ToString
Description
Provides an IIdentity-derived class to be used by FormsAuthenticationModule. It provides a way for an application to access the cookie authentication ticket. This class cannot be inherited.
FormsIdentity
Example Syntax:
ToString
Initializes a new instance of the System.Web.Security.FormsIdentity class. The authentication ticket upon which this identity is based.
AuthenticationType
ToString
The type of the identity (in this case, “Forms”).
IsAuthenticated
ToString
Indicates whether authentication took place.
Name
ToString
The name of the identity (in this case, the user name).
Ticket
ToString
Returns the FormsAuthenticationTicket associated with the current request.
PassportAuthenticationEventArgs class (System.Web.Security)
ToString
Description
The event argument passed to the PassportAuthentication_OnAuthenticate event by the PassportAuthentication module. Since there is already an identity at this point, this is useful mainly for attaching a custom IPrincipal object to the context using the supplied identity.
For more information about handling events, see.
PassportAuthenticationEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.Web.Security.PassportAuthenticationEventArgs class. The identity object The context for the event.
Context
ToString
The HttpContext intrinsic provides access to Request, Response, and User objects.
Identity
ToString
An authenticated Passport identity.
User
ToString
Associates an IPrincipal object with the request.
The User object should be attached to the context. If User is non-null and Context.User is null, the PassportAuthenticationModule will initialize Context.User with PassportAuthenticationEventArgs.User.
PassportAuthenticationEventHandler delegate (System.Web.Security)
ToString
Description
Represents the method that handles the PassportAuthentication_OnAuthenticate event of a PassportAuthenticationModule. The object that raised the event. A PassportAuthenticationEventArgs object that contains the event data.
When you create a System.Web.Security.PassportAuthenticationEventHandler delegate, you identify the method to handle the event. To associate the event with your EventHandler, add an instance of the delegate to the event. The EventHandler is called whenever the event occurs, unless you remove the delegate. For more information about EventHandler delegates, see.
PassportAuthenticationModule class (System.Web.Security)
ToString
Description
Provides a wrapper around PassportAuthentication services. This class cannot be inherited.
Installation of the Passport SDK is still required, as is registration of the site with the Passport authority. The PassportAuthentication_OnAuthenticate event is raised for applications that are designed to attach a custom IPrincipal object to the context. The Passport service itself does the authentication, so that cannot be overridden.
PassportAuthenticationModule
Example Syntax:
ToString
ToString
Raised during authentication. This is a Global.asax event that must be named PassportAuthentication_OnAuthenticate event.
Advanced users use this event to attach a custom IPrinciple object to the context.
Dispose
Disposes of the module derived from IHttpModule when called by the HttpRuntime.
Call System.Web.Security.PassportAuthenticationModule.Dispose when you are finished using the System.Web.Security.PassportAuthenticationModule. The System.Web.Security.PassportAuthenticationModule.Dispose method leaves the System.Web.Security.PassportAuthenticationModule in an unusable state. After calling System.Web.Security.PassportAuthenticationModule.Dispose, you must release all references to the System.Web.Security.PassportAuthenticationModule so the memory it occupied can be reclaimed by garbage collection.
Init
Initializes the module (derived from IHttpModule) when called by the HttpRuntime. The HttpApplication module
PassportIdentity class (System.Web.Security)
ToString
Description
Provides access to the Passport profile information contained in the Passport profile cookies. This is an IIdentity-derived class. This class cannot be inherited.
ASP.NET Beta 2 requires the 1.4 version of the Passport SDK.
PassportIdentity
Example Syntax:
ToString
Creates a new instance of the PassportIdentity object.
AuthenticationType
ToString
The type of the identity. In this case, Passport.
See the Passport SDK documentation for more information about PassportIdentity.AuthenticationType.
Error
ToString
Returns an error state associated with the current Passport ticket. For more information, see the error property in the Passport documentation.
GetFromNetworkServer
ToString
Returns true if a connection is coming back from the Passport server (logon, update, or registration) and if the Passport data contained on the query string is valid.
HasSavedPassword
ToString
Returns true if the Passport member's ticket indicates that the password was saved on the Passport logon page the last time the ticket was refreshed.
For more information, see the Passport SDK documentation.
HasTicket
ToString
Returns true if there is a Passport ticket as a cookie on the query string.
For more information, see the Passport SDK documentation.
IsAuthenticated
ToString
Returns true if the user is authenticated by a Passport authority.
For more information, see the Passport SDK documentation.
Item
ToString
Acceses Passport profile attributes. Calling this property is the equivalent of calling GetProfileObject or SetProfileObject.
For more information, see the Passport SDK documentation. The Passport profile attribute to query.
Name
ToString
Consists of the name of the identity. In this case, it is the value of the Passport PUID.
For more information, see the Passport SDK documentation.
TicketAge
ToString
Consists of the time, in seconds, since the last ticket was issued or refreshed.
For more information, see the Passport SDK documentation.
TimeSinceSignIn
ToString
Consists of the time, in seconds, since a member's log on to the Passport logon server.
For more information, see the Passport SDK documentation.
AuthUrl
Returns a string containing the login server URL for a member, along with the optional information sent to the login server in the query string.
AuthUrl
Similar to AuthUrl( ). Returns the authentication server URL for a member.
For more information about the parameters for this method, see the Passport SDK documentation. Sets the URL of the location that the Login server should redirect to after sign-in is complete. Specifies the interval during which members must have last signed in. Determines how the iTimeWindow will be used. Specifies variables to be appended to the URL of the Co-branding Template script page that was specified at initial participant registration. Specifies the language in which the required domain authority page should be displayed. Specifies the domain in which the Passport should be created. Specifies data collection policies for purposes of COPPA compliance. Declares whether the actual sign-in UI should be served HTTPS from the Passport domain authority.
AuthUrl
AuthUrl2
Retrieves a String containing the logon server URL for a member, as well as the optional information sent to the logon server in the query string.
Return Value: The logon server URL for a member, as well as the optional information sent to the logon server in the query string.
This URL can be used to generate a link for a member who has not signed in previously or who has an expired ticket. For more details, see IPassportManager2::Authaurl2 in the Passport SDK documentation.
AuthUrl2
Retrieves a String containing the logon server URL for a member, as well as the optional information sent to the logon server in the query string.
Return Value: The logon server URL for a member, as well as the optional information sent to the logon server in the query string.
This URL can be used to generate a link for a member who has not signed in previously or who has an expired ticket. For more details, see IPassportManager2::AuthUrl2 in the Passport SDK documentation. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2.
AuthUrl2
Retrieves a String containing the logon server URL for a member, as well as the optional information sent to the logon server in the query string.
Return Value: The logon server URL for a member, as well as the optional information sent to the logon server in the query string.
You can use this URL to generate a link for a member who has not previously signed in or who has an expired ticket. For more details, see IPassportManager2::AuthUrl2 in the Passport SDK documentation. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2.
Compress
Compresses data.
Return Value: Compressed data.
For more information about IPassportCrypt::Compress, see the Passport SDK documentation. Data to be compressed.
CryptIsValid
Returns true if the key used for encryption and decryption is valid and if the Passport Manager object is in a valid state for encryption.
See the Passport SDK documentation for IPassportCrypt::get_IsValid.
CryptPutHost
Sets the key being used by the current Passport Crypt object by referring to the host name or IP address used by the desired installation.
See the Passport SDK documentation for IPassportCrypt::put_Host. Host name or IP address.
CryptPutSite
Sets the key being used by the current Passport Crypt object by referring to the site-name label assigned to that key when the key was first installed.
See the Passport SDK documentation for IPassportCrypt::put_Site.
Decompress
Decompresses data that has been compressed by the Compress method.
Return Value: Decompressed data.
See the Passport SDK documentation for IPassportCrypt::Compress. Data to be decompressed.
Decrypt
Decrypts data using the Passport participant key for the current site.
Return Value: Decrypted data.
See the Passport SDK documentation for IPassportCrypt::Decrypt. The data to be decrypted.
Encrypt
Encrypts data using the Passport participant key for the current site. Maximum input size is 2045 characters.
Return Value: Encrypted data.
See the Passport SDK documentation for IPassportCrypt::Encrypt. The data to be encrypted.
Finalize
Calls Finalize method.
GetDomainAttribute
Provides information for a Passport domain by querying the Passport CCD for the requested DomainAttribute.
For more information, see the Passport SDK documentation. The name of the attribute value to retrieve. Specifies the language in which various Passport network pages should be displayed to the member. The domain authority name to query for an attribute.
GetDomainFromMemberName
Returns the Passport domain from the member-name string. Name of the Passport member
GetIsAuthenticated
Returns true if the user is authenticated by a Passport authority.
Return Value: true if the user is authenticated by a Passport authority.
See passport documentation for IPassportManager::IsAuthenticated. Specifies the interval during which members must have last signed in to the calling domain. Determines how iTimeWindow is used. Enables checking for a secure logon.
GetIsAuthenticated
Returns true if the user is authenticated by a Passport authority.
Return Value: true if the user is authenticated by a Passport authority.
See Passport documentation for IPassportManager::IsAuthenticated. Specifies the interval during which members must have last signed in to the calling domain. Determines how iTimeWindow is used. Enables checking for a secure logon.
GetProfileObject
Returns Passport profile information for the supplied profile attribute. The Passport profile attribute to query.
HasFlag
Returns true if a given flag is set in this user's profile.
For more information, see the Passport SDK documentation. The Passport profile flag to query.
HasProfile
Returns true if a given profile attribute exists in this user's profile.
For more information, see the Passport SDK documentation. The Passport profile attribute to query.
HaveConsent
Returns true if Full Consent is granted in this user's profile.
For more information, see the Passport SDK documentation. true if Full Consent is required for Passport Authentication.
LoginUser
Logs the user on, either by generating a 302-redirect URL or initiating a Passport-aware client authentication exchange.
This method supports Passport-aware client applications. Note that there are some policy restrictions on the use of this method in certain scenarios. Note also that this method should not be called from a frameset, as suggested in the Passport documentation. Finally, this method requires that Msppfltr.dll be properly installed and running as an ISAPI filter at the global level of the participant Web site.
LoginUser
Logs the user on, either by generating a 302-redirect URL or initiating a Passport-aware client authentication exchange.
This method supports Passport-aware client applications. Note that there are some policy restrictions on the use of this method in certain scenarios. Note also that this method should not be called from a frameset, as suggested in the Passport documentation. Finally, this method requires that Msppfltr.dll be properly installed and running as an ISAPI filter at the global level of the participant Web site. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser.
LoginUser
Logs the user on, either by generating a 302-redirect URL or initiating a Passport-aware client authentication exchange.
This method supports Passport-aware client applications. Note that there are some policy restrictions on the use of this method in certain scenarios. Note also that this method should not be called from a frameset, as suggested in the Passport documentation. Finally, this method requires that Msppfltr.dll be properly installed and running as an ISAPI filter at the global level of the participant Web site. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser.
LogoTag
Returns an HTML snippet containing an image tag for a Passport link. This is based on the current state of the identity (already signed in, and such).
LogoTag
Similar to LogoTag( ), this method returns an HTML snippet for the Passport Logo for the current member
For additional details on the parameters for this method, see the Passport SDK documentation. Sets the URL of the location that the Login server should redirect members to after sign-in is complete. Specifies the interval during which members must have last signed in. Determines how iTimeWindow gets used. Specifies variables to be appended as query string variables to the URL of the participant's Co-branding Template script page. Specifies the language to be used for the Login page that is displayed to the member. Declares whether this method is being called from an HTTPS (SSL) page. Specifies the domain in which the Passport should be created. Specifies data collection policies for purposes of COPPA compliance. Declares whether the actual sign-in UT should be served HTTPS from the Passport domain authority.
LogoTag
LogoTag2
Returns an HTML fragment containing an <img> tag for a Passport link. This is based on the current state of the identity (already logged on, and so on).
The link image displays either Sign In if no valid ticket cookie is detected, or Sign Out if a valid cookie ticket is detected. For more details, see IPassportManager2::LogoTag2 in the Passport SDK documentation.
LogoTag2
Returns an HTML fragment containing an <img> tag for a Passport link. This is based on the current state of the identity (already logged on, and so on).
The link image displays either Sign In if no valid ticket cookie is detected, or Sign Out if a valid cookie ticket is detected. For more details, see IPassportManager2::LogoTag2 in the Passport SDK documentation. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser.
LogoTag2
Returns an HTML fragment containing an <img> tag for a Passport link. This is based on the current state of the identity (already logged on, and so on).
The link image displays either Sign In if no valid ticket cookie is detected, or Sign Out if a valid cookie ticket is detected. For more details, see IPassportManager2::LogoTag2 in the Passport SDK documentation. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser.
SignOut
Logs off the given Passport member from the current session.
For more information, see the Passport SDK documentation. The SignOut image to be used.
UrlAuthorizationModule class (System.Web.Security)
ToString
Description
Provides URL-based authorization services for allowing or denying access to specified resources. This class cannot be inherited.
UrlAuthorizationModule
Example Syntax:
ToString
Dispose
Called by the HTTP runtime to dispose of the module.
Call System.Web.Security.UrlAuthorizationModule.Dispose when you are finished using the System.Web.Security.UrlAuthorizationModule. The System.Web.Security.UrlAuthorizationModule.Dispose method leaves the System.Web.Security.UrlAuthorizationModule in an unusable state. After calling System.Web.Security.UrlAuthorizationModule.Dispose, you must release all references to the System.Web.Security.UrlAuthorizationModule so the memory it occupid can be reclaimed by garbage collection.
Init
Initializes the module. The Http application.
WindowsAuthenticationEventArgs class (System.Web.Security)
ToString
Description
Provides data for the WindowsAuthentication event.
This is the event argument passed to the WindowsAuthentication_OnAuthenticate event handler. Contains a WindowsIdentity object and the IPrincipal object used for the context.
WindowsAuthenticationEventArgs
Example Syntax:
ToString
Initializes a newly created instance of the WindowsAuthenticationEventArgs Class. The windows identity object. The context for the event.
Context
ToString
The HttpContext intrinsic (provides access to Request, Response, and User objects).
Identity
ToString
An authenticated Windows identity.
User
ToString
IPrincipal object to be associated with the request. The user object should be attached to the contextIf User is non null and Context.User is null, the WindowsAuthenticationModule will initialize Context.User with WindowsAuthenticationEventArgs.User.
WindowsAuthenticationEventHandler delegate (System.Web.Security)
ToString
Description
Represents the method that handles the WindowsAuthentication_OnAuthenticate event of a WindowsAuthenticationModule. The source of the event. A WindowsAuthenticationEventArg that contains the event data.
When you create a System.Web.Security.WindowsAuthenticationEventHandler delegate, you identify the method to handle the event. To associate the event with your EventHandler, add an instance of the delegate to the event. The EventHandler is called whenever the event occurs, unless you remove the delegate. For more information about EventHandler delegates, see.
WindowsAuthenticationModule class (System.Web.Security)
ToString
Description
Enables ASP.NET applications to use Windows/IIS authentication. This class cannot be inherited.
WindowsAuthenticationModule
Example Syntax:
ToString
ToString
Raised during authentication. This is a Global.asax event that must be named PassportAuthentication_OnAuthenticate event. It is used primarily to attach a custom IPrincipal object to the context.
For more information about handling events, see.
Dispose
Disposes of the module derived from IHttpModule when called by the HttpRuntime.
Call System.Web.Security.WindowsAuthenticationModule.Dispose when you are finished using the System.Web.Security.WindowsAuthenticationModule. The System.Web.Security.WindowsAuthenticationModule.Dispose method leaves the System.Web.Security.WindowsAuthenticationModule in an unusable state. After calling System.Web.Security.WindowsAuthenticationModule.Dispose, you must release all references to the System.Web.Security.WindowsAuthenticationModule so the memory it occupied can be reclaimed by garbage collection.
Init
Initializes the module derived from IHttpModule when cal
System.Web.Services
Description
The System.Web.Services namespace consists of the classes that enable you to build and use Web Services. A Web Service is a programmable entity residing on a Web Server exposed via standard Internet protocols.
WebMethodAttribute class (System.Web.Services)
Description
Adding this attribute to a method within an ASP.NET Web Service makes the method callable from remote Web clients. This class cannot be inherited.
Methods within a class that have this attribute set are called Web Service methods. The method and class must be public and running inside an ASP.NET Web application.
Constructors:
WebMethodAttribute
Example Syntax:
Initializes a new instance of the System.Web.Services.WebMethodAttribute class.
WebMethodAttribute
Example Syntax:
Initializes a new instance of the System.Web.Services.WebMethodAttribute class. Initializes whether session state is enabled for the Web Service method.
WebMethodAttribute
Example Syntax:
Initializes a new instance of the System.Web.Services.WebMethodAttribute class. Initializes whether session state is enabled for the Web Service method. Initializes the transaction support of a Web Service method.
WebMethodAttribute
Example Syntax:
Initializes a new instance of the System.Web.Services.WebMethodAttribute class. Initializes whether session state is enabled for the Web Service method. Initializes the transaction support of a Web Service method. Initializes the number of seconds the response is cached.
WebMethodAttribute
Example Syntax:
Initializes a new instance of the System.Web.Services.WebMethodAttribute class. Initializes whether session state is enabled for the Web Service method. Initializes the transaction support of a Web Service method. Initializes the number of seconds the response is cached. Initializes whether the response for this request is buffered.
Properties:
BufferResponse
Gets or sets whether the response for this request is buffered.
Setting System.Web.Services.WebMethodAttribute.BufferResponse to true, serializes the response of the Web Service method into a memory buffer until either the response is completely serialized or the buffer is full. Once the response is buffered, it is returned to the Web Service client over the network. When System.Web.Services.WebMethodAttribute.BufferResponse is false, the response to the Web Service method is sent back to the client as it is serialized. In general, you only want to set System.Web.Services.WebMethodAttribute.BufferResponse to false, if it is known that a Web Service method returns large amounts of data to the client. For smaller amounts of data, Web Service performance is better with System.Web.Services.WebMethodAttribute.BufferResponse to true.
CacheDuration
Gets or sets the number of seconds the response should be held in the cache.
When caching is enabled requests and responses are held in memory on the server for at least the cache duration so caution must be used if you expect requests or responses to be very large or you expect requests to vary widely.
Description
A descriptive message describing the Web Service method.
The descriptive message is displayed to prospective consumers of the Web Service when description documents for the Web Service are generated, such as the Service Description and the Service help page.
EnableSession
Indicates whether session state is enabled for a Web Service method.
In order to store session state in the ASP.NET System.Web.SessionState.HttpSessionState object, the Web Service must inherit from System.Web.Services.WebService and a System.Web.Services.WebMethodAttribute applied to the Web Service method, setting the System.Web.Services.WebMethodAttribute.EnableSession property to true. If session state is not needed for a Web Service method, then disabling it may improve performance.
MessageName
The name used for the Web Service method in the data passed to and returned from a Web Service method.
The System.Web.Services.WebMethodAttribute.MessageName property can be used to alias method or property names. The most common use of the System.Web.Services.WebMethodAttribute.MessageName property will be to uniquely identify polymorphic methods. By default, System.Web.Services.WebMethodAttribute.MessageName is set to the name of the Web Service method. Therefore, if a Web Service contains two or more Web Service methods with the same name, you can uniquely identify the individual Web Service methods by setting the System.Web.Services.WebMethodAttribute.MessageName to a name unique within the Web Service, without changing the name of the actual method name in code.
TransactionOption
Indicates the transaction support of a Web Service method.
Web Service methods can only participate as the root object in a transaction, due to the stateless nature of the HTTP protocol. Web Service methods can invoke COM objects that participate in the same transaction as the Web Service method, if the COM object is marked to run within a transaction in the Component Services administrative tool. If a Web Service method, with a System.Web.Services.WebMethodAttribute.TransactionOption property of Required or RequiresNew invokes another Web Service method with a System.Web.Services.WebMethodAttribute.TransactionOption property of Required or RequiresNew, each Web Service method participates in their own transaction, because a Web Service method can only act as the root object in a transaction.
TypeId
Methods:
WebService class (System.Web.Services)
ToString
Description
Defines the optional base class for Web Services, which provides direct access to common ASP.NET objects, like those for application and session state.
If you don't need access to the common ASP.NET objects, you can still create a Web Service without deriving from System.Web.Services.WebService. Additional ASP.NET objects can be accessed through System.Web.Services.WebService.Context.
WebService
Example Syntax:
ToString
Application
ToString
Gets the application object for the current HTTP request.
Web Services can utilize both application state and session state. Application state is maintained across all sessions accessing a Web Service regardless of whether session state is turned off for a method(by using the System.Web.Services.WebMethodAttribute.EnableSession property of the System.Web.Services.WebMethodAttribute).
Container
Context
ToString
Description
Gets the ASP.NET System.Web.HttpContext for the current request, which encapsulates all HTTP-specific context used by the HTTP server to process Web requests.
If a Web Service method is one-way, then the System.Web.Services.WebService.Context property is always null. A Web Service is one-way when a System.Web.Services.Protocols.SoapDocumentMethodAttribute or System.Web.Services.Protocols.SoapRpcMethodAttribute is applied to a Web Service method and the System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay property is set to true.
DesignMode
Events
Server
ToString
Description
Gets the System.Web.HttpServerUtility for the current request.
The System.Web.HttpServerUtility class provides several methods that can be used in the processing of Web requests, including System.Web.HttpServerUtility.CreateObject(System.String) (for instantiating COM objects).
Session
ToString
Gets the System.Web.SessionState.HttpSessionState instance for the current request.
If a Web Service method is one-way, then the System.Web.Services.WebService.Session property is always null. A Web Service is one-way when a System.Web.Services.Protocols.SoapDocumentMethodAttribute or System.Web.Services.Protocols.SoapRpcMethodAttribute is applied to a Web Service method and the System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay property is set to true
Site
User
ToString
Description
Gets the ASP.NET server System.Web.HttpContext.User object. Can be used to authenticate whether a user is authorized to execute the request.
Both Internet Information Services (IIS) and the NET Framework need to be configured for authentication in order for the System.Web.Services.WebService.User property to be meaningful. Authentication is the process of accepting credentials from a user and validating those credentials against some authority. If the credentials are valid, you have an authenticated identity. Authentication in the .NET Framework is configured by placing entries in the web.config file. Placing the XML in the following code into a web.config file sets the authentication mode to Windows.
WebServiceAttribute class (System.Web.Services)
ToString
Description
Used to add additional information to a Web Service, such as a string describing its functionality.
The System.Web.Services.WebServiceAttribute is not required for a Web Service to be published and executed. You can use the WebServiceAttribute to specify a name for the Web Service that is not restricted by the rules for a Common Language Runtime identifier, which is used in the Service Description and the Service help page for the Web Service.
ToString
The default value for the System.Web.Services.WebServiceAttribute.Namespace property. This field is constant.
WebServiceAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.WebServiceAttribute class.
Description
ToString
Description (String);
Description
A descriptive message for the Web Service.
The descriptive message is displayed to prospective consumers of the Web Service when description documents for the Web Service are generated, such as the Service Description and the Service help page.
Name
ToString
Gets or sets the name of the ASP.NET Web Service.
The Service Description is generated when a user navigates to the URL for the Web Service and supplies a query string of ?WSDL. Within the Service Description, the System.Web.Services.WebServiceAttribute.Name property identifies the local part of the XML qualified name for the Web Service. The Name property is also used to display the name of the Web Service on the Service help page. The Service help page is displayed when a prospective consumer navigates to the .asmx page for the Web Service without specifying a Web Service method name and its parameters.
Namespace
ToString
Gets or sets the default XML namespace to use for the Web Service.
XML namespaces offer a way to create names in an XML document that are identified by a Uniform Resource Identifier (URI). By using XML namespaces you can uniquely identify elements or attributes in a XML document. The Service Description for a Web Service is defined in XML, specifically in Web Service Description Language (WSDL).
TypeId
WebServiceBindingAttribute class (System.Web.Services)
ToString
Description
Declares the binding one or more Web Service methods implemented within the class implementing the Web Service. This class cannot be inherited.
A binding, as defined by Web Services Description Language(WSDL), is similar to an interface, in that it defines a concrete set of operations. Each Web Service method is an operation within a particular binding. Web Service methods are members of either the default binding for a Web Service or in a binding specified within a System.Web.Services.WebServiceBindingAttribute applied to a class implementing a Web Service. A Web Service can implement multiple bindings, by applying multiple System.Web.Services.WebServiceBindingAttribute attributes to a Web Service.
WebServiceBindingAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.WebServiceBindingAttribute class.
WebServiceBindingAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.WebServiceBindingAttribute class setting the name of the binding the Web Service method is implementing.
This constructor is used to specify a name for a binding defined in the Web Service it is applied to and is a member of the default namespace. The name of the binding a Web Service method is implementing an operation for. Sets the System.Web.Services.WebServiceBindingAttribute.Name property.
WebServiceBindingAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.WebServiceBindingAttribute class.
This constructor is used to specify a name for a binding defined in the Web Service it is applied to that and is a member of the supplied namespace. The name of the binding a Web Service method is implementing an operation for. Sets the System.Web.Services.WebServiceBindingAttribute.Name property. The namespace associated with the binding. Sets the System.Web.Services.WebServiceBindingAttribute.Namespace property.
WebServiceBindingAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.WebServiceBindingAttribute class.
This constructor is used to specify a name for a binding not defined in the Web Service it is applied to that and is a member of the supplied namespace. The name of the binding a Web Service method is implementing an operation for. Sets the System.Web.Services.WebServiceBindingAttribute.Name property. The namespace associated with the binding. Sets the System.Web.Services.WebServiceBindingAttribute.Namespace property. The location where the binding is defined.
Location
ToString
Gets or sets the location where the binding is defined.
Name
ToString
WebServicesConfigurationSectionHandler class (System.Web.Services.Configuration)
Description
The configuration section handler for the webServices section of the Config.Web configuration file. The section handler participates in the resolution of configuration settings within the webServices portion of a Config.Web.
Constructors:
WebServicesConfigurationSectionHandler
Example Syntax:
Methods:
Create
Parses the configuration settings for the webServices portion of a Web.config configuration file to populate the values of a WebServicesConfiguration object and returning it. Reference to the “default” value provided by the parent IConfigurationSectionHandler. Provides access to the raw XML contents within a configuration file. The virtual path for which the configuration section handler should compute values.
XmlFormatExtensionAttribute class (System.Web.Services.Configuration)
ToString
Description
XmlFormatExtensionAttribute
Example Syntax:
ToString
XmlFormatExtensionAttribute
Example Syntax:
ToString
XmlFormatExtensionAttribute
Example Syntax:
ToString
XmlFormatExtensionAttribute
Example Syntax:
ToString
XmlFormatExtensionAttribute
Example Syntax:
ToString
XmlFormatExtensionAttribute
Example Syntax:
ToString
Properties:
ElementName
ToString
ExtensionPoints
ToString
Namespace
ToString
TypeId
XmlFormatExtensionPointAttribute class (System.Web.Services.Configuration)
ToString
Description
XmlFormatExtensionPointAttribute
Example Syntax:
ToString
AllowElements
ToString
MemberName
ToString
TypeId
XmlFormatExtensionPrefixAttribute class (System.Web.Services.Configuration)
ToString
Description
XmlFormatExtensionPrefixAttribute
Example Syntax:
ToString
XmlFormatExtensionPrefixAttribute
Example Syntax:
ToString
Namespace
ToString
Prefix
ToString
The System.Web.Services.Description namespace consists of the classes that enable you to publicly describe a Web Service by using the Web Service
Description Language (WSDL). Each class in the System.Web.Services.Description namespace corresponds to a specific element in the WSDL specification, and the class hierarchy corresponds to the XML structure of a valid WSDL document. For more information about WSDL, see the specification at http://www.w3.org/TR/wsdl/.
Binding class (System.Web.Services.Description)
Description
Specifies the concrete data format and protocols used in the Web Service. This class cannot be inherited.
Constructors:
Binding
Example Syntax:
Properties:
Documentation
Extensions
Description
Gets the collection of extensibility elements used in the Web Service.
Name
Gets or sets a string value containing the name of the System.Web.Services.Description.Binding.
Operations
Gets the collection of the specifications for data formats and message protocols used in the action supported by the Web Service.
ServiceDescription
Gets the System.Web.Services.Description.ServiceDescription instance of which the System.Web.Services.Description.Binding is a member.
Type
Gets or sets a value representing the XML datatype definitions used by the Web Service.
The default implementation is String.Empty.
Methods:
BindingCollection class (System.Web.Services.Description )
ToString
Description
Represents a collection of System.Web.Services.Description.Binding elements supported by the Web Service. This class cannot be inherited.
Count
InnerList
Item
ToString
System.Web.Services.Description.Binding
Description
Gets or sets the value of a System.Web.Services.Description.Binding at the specified zero-based index. The zero-based index of the System.Web.Services.Description.Binding whose value is modified or returned.
Item
ToString
Gets a System.Web.Services.Description.Binding specified by its Name property. A string value representing the name of the Binding returned.
List
Table
Add
Adds the specified System.Web.Services.Description.Binding to the end of the System.Web.Services.Description.BindingCollection.
Return Value: Returns the zero-based index where binding has been added. The System.Web.Services.Description.Binding to be added to the collection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.Binding is a member of the System.Web.Services.Description.BindingCollection.
Return Value: true if binding is a member of the System.Web.Services.Description.BindingCollection; otherwise, false. A System.Web.Services.Description.Binding object.
CopyTo
Copies the entire System.Web.Services.Description.BindingCollection to a compatible one-dimensional array of type System.Web.Services.Description.Binding, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.Binding serving as the destination for the copy action. The zero-based index at which to start placing the copied collection.
GetKey
Returns the name of the System.Web.Services.Description.Binding associated with the value passed by reference. An object for which to return the name of the key.
IndexOf
Searches for the specified System.Web.Services.Description.Binding and returns the zero-based index of the first occurrence within the collection.
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.Binding object.
Insert
Adds the specified System.Web.Services.Description.Binding to the System.Web.Services.Description.BindingCollection at the specified index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert binding. The System.Web.Services.Description.Binding to be added to the collection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.Binding from the System.Web.Services.Description.BindingCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.BindingCollection.Count. A System.Web.Services.Description.Binding object.
SetParent
Sets the parent System.Web.Services.Description.ServiceDescription of a member of System.Web.Services.Description.BindingCollection. An object, of type System.Web.Services.Description.Binding, within the collection. The object, of type System.Web.Services.Description.ServiceDescription, to set as the parent.
DocumentableItem class (System.Web.Services.Description)
ToString
Description
Represents the abstract base class from which several classes in the System.Web.Services.Description namespace are derived.
Several classes are derived from this class, including: System.Web.Services.Description.BindingSystem.Web.Services.Description.ImportSystem.Web.Services.Description.MessageSystem.Web.Services. Description.MessagePartSystem.Web.Services.Description.OperationSystem.Web.Services.Description.OperationBindingSystem.Web.Services. Description.OperationMessageSystem.Web.Services.Description.PortSystem.Web.Services.Description.PortTypeSystem.Web.Services.Description. ServiceSystem.Web.Services.Description.Types This base class contains only one property, the Documentation property. It represents the text documentation for a specific XML element.
DocumentableItem
Example Syntax:
ToString
Documentation
ToString
Gets or sets the documentation for the instance of the System.Web.Services.Description.DocumentableItem.
In a derived class, this property represents the text comments added to an element of the Web Service. The default implementation is String.Empty.
FaultBinding class (System.Web.Services.Description)
ToString
Description
Specifies the format for any error messages that might be output as a result of the operation. This class cannot be inherited.
FaultBinding
Example Syntax:
ToString
Documentation
Extensions
ToString
Description
Gets the collection of extensibility elements associated with the System.Web.Services.Description.FaultBinding.
Name
OperationBinding
FaultBindingCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.FaultBinding instances. This class cannot be inherited.
Count
InnerList
Item
ToString
System.Web.Services.Description.FaultBinding
Description
Gets or sets the value of a System.Web.Services.Description.FaultBinding at the specified zero-based index. The zero-based index of the System.Web.Services.Description.FaultBinding whose value is modified or returned.
Item
ToString
Gets a System.Web.Services.Description.FaultBinding specified by its System.Web.Services.Description.FaultBinding.Name property. The string value representing the name of the System.Web.Services.Description.FaultBinding returned.
List
Table
Add
Adds the specified System.Web.Services.Description.FaultBinding to the end of the System.Web.Services.Description.FaultBindingCollection.
Return Value: Returns the index where bindingOperationFault has been added. The System.Web.Services.Description.FaultBinding to be added to the collection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.FaultBinding is a member of the FaultBindingCollection.
Return Value: true if bindingOperationFault is a member of the FaultBindingCollection; otherwise, false. A System.Web.Services.Description.FaultBinding object.
CopyTo
Copies the entire FaultBindingCollection to a compatible one-dimensional array of type System.Web.Services.Description.FaultBinding, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.FaultBinding serving as the destination for the copy action. The zero-based index at which to start placing the copied collection.
GetKey
Returns the name of the System.Web.Services.Description.FaultBinding associated with the value passed by reference. An object for which to return the name.
IndexOf
Searches for the specified System.Web.Services.Description.FaultBinding and returns the zero-based index of the first occurrence within the collection.
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.FaultBinding instance.
Insert
Adds the specified System.Web.Services.Description.FaultBinding to the FaultBindingCollection at the specified zero-based index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert bindingOperationFault. The System.Web.Services.Description.FaultBinding to be added to the collection.
Remove
Removes the first occurrence the specified System.Web.Services.Description.FaultBinding from the FaultBindingCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.FaultBindingCollection.Count. The System.Web.Services.Description.FaultBinding object to be removed from the collection.
SetParent
Sets the parent System.Web.Services.Description.OperationBinding of a member of the FaultBindingCollection instance. An object, of type System.Web.Services.Description.FaultBinding, within the FaultBindingCollection. The object, of type System.Web.Services.Description.OperationBinding, to set as the parent.
HttpAddressBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to a System.Web.Services.Description.Port within a Web Service. This class cannot be inherited.
This class, through its System.Web.Services.Description.HttpAddressBinding.Location property, specifies the base URI for the Web Service. For more information, see.
HttpAddressBinding
Example Syntax:
ToString
Handled
Location
ToString
Description
Gets or sets a value representing the URL of the .asmx file containing the methods exposed by the Web Service.
Parent
Required
HttpBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to a System.Web.Services.Description.Binding within a Web Service. This class cannot be inherited.
This class specifies that information is to be passed by means of HTTP. For more information about specification of protocols for Web Services, see.
ToString
Specifies the URI (http://schemas.xmlsoap.org/wsdl/http/) for the XML namespace of the HttpBinding class.
HttpBinding
Example Syntax:
ToString
Handled
Parent
Required
Verb
ToString
Description
Gets or sets a value indicating whether the Http request will be made using the “GET” or “POST” method.
HttpOperationBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to an System.Web.Services.Description.OperationBinding within a Web Service. This class cannot be inherited.
This class specifies how a Web Service passes information by means of HTTP. For more information, see.
HttpOperationBinding
Example Syntax:
ToString
Handled
Location
ToString
Description
Gets or sets a value representing the relative URL, within the WSDL document, of the action supported by the HttpOperationBinding.
Parent
Required
HttpUrlEncodedBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to an System.Web.Services.Description.InputBinding within a Web Service. This class cannot be inherited.
This class specifies that the incoming data will be in the format “name=value&name value”, encoded from an System.Web.UI.HtmlControls.HtmlForm, whether the value of the HtmlForm's System.Web.UI.HtmlControls.HtmlForm.Method property is POST or GET.
HttpUrlEncodedBinding
Example Syntax:
ToString
Handled
Parent
Required
HttpUrlReplacementBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to an System.Web.Services.Description.InputBinding within a Web Service. It specifies the format for data transmission through HTTP. This class cannot be inherited.
This class allows users to specify a custom format for data transmission, rather than limiting them to the standard format, “name=value&name=value”, used in HTTP query strings. For example, a developer may decide to use /name,value/name,value or some other custom format instead.
HttpUrlReplacementBinding
Example Syntax:
ToString
Handled
Parent
Required
Import class (System.Web.Services.Description)
ToString
Description
Associates an XML namespace with a document location. This class cannot be inherited.
Many of the tags in the WSDL schema can contain the tag. It allows the separation of different elements of the Web Service into different documents, which can then be imported as needed.
Import
Example Syntax:
ToString
Documentation
Location
ToString
Description
Gets or sets a reference to the XML Location attribute of the System.Web.Services.Description.Import instance.
Namespace
ToString
Gets or sets a reference to the XML Namespace of the System.Web.Services.Description.Import instance.
ServiceDescription
ToString
Gets a reference to the System.Web.Services.Description.ServiceDescription of which the Import instance is a member.
ImportCollection class (System.Web.Services.Description)
ToString
Description
Provides a collection of System.Web.Services.Description.Import instances representing documents to be imported into the Web Service. This class cannot be inherited.
Count
InnerList
Item
ToString
Description
Gets or sets the value of an System.Web.Services.Description.Import at the specified zero-based index. The zero-based index of the Import whose value is modified or returned.
List
Table
Add
Adds the specified System.Web.Services.Description.Import instance to the end of the System.Web.Services.Description.ImportCollection.
Return Value: Returns the index where import has been added. The System.Web.Services.Description.Import to be added to the collection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.Import instance is a member of the System.Web.Services.Description.ImportCollection.
Return Value: true if import is a member of the System.Web.Services.Description.ImportCollection; otherwise, false. An System.Web.Services.Description.Import object.
CopyTo
Copies the entire ImportCollection to a compatible one-dimensional array of type System.Web.Services.Description.Import, starting at the specified zero-based index of the target array. The destination array, of type System.Web.Services.Description.Import. The zero-based index at which to start placing the copied collection.
IndexOf
Searches for the specified System.Web.Services.Description.Import and returns the zero-based index of the first occurrence within the collection.
Return Value: Returns a 32-bit signed integer. An System.Web.Services.Description.Import object.
Insert
Adds the specified System.Web.Services.Description.Import instance to the ImportCollection at the specified index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert import. The System.Web.Services.Description.Import to be added to the collection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.Import from the ImportCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.ImportCollection.Count. An System.Web.Services.Description.Import object.
SetParent
Sets the parent System.Web.Services.Description.ServiceDescription of the specified System.Web.Services.Description.Import. An object, of type System.Web.Services.Description.Import, within the collection. The object, of type System.Web.Services.Description.ServiceDescription, to set as the parent.
InputBinding class (System.Web.Services.Description)
ToString
Description
Provides a set of specifications for data formats and protocols used by the Web Service for input messages. This class cannot be inherited.
InputBinding
Example Syntax:
ToString
Documentation
Extensions
ToString
Description
Gets the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion associated with the InputBinding instance.
Name
OperationBinding
Message class (System.Web.Services.Description)
ToString
Description
Defines in the abstract the content, either document-oriented or procedure-oriented, of data passed by the Web Service. This class cannot be inherited.
Message
Example Syntax:
ToString
Documentation
Name
ToString
Description
Gets or sets the name of the Message instance.
Parts
ToString
Gets the collection of all the System.Web.Services.Description.MessagePart objects contained in the Message instance.
ServiceDescription
ToString
Gets the System.Web.Services.Description.ServiceDescription of which the Message instance is a member.
FindPartByName
Searches the System.Web.Services.Description.MessagePartCollection returned by the System.Web.Services.Description.Message.Parts property, and returns the named System.Web.Services.Description.MessagePart. The string naming the System.Web.Services.Description.MessagePart to be returned.
FindPartsByName
Searches the System.Web.Services.Description.MessagePartCollection returned by the System.Web.Services.Description.Message.Parts property and returns an array of type System.Web.Services.Description.MessagePart containing the named instances.
Return Value: An array of type System.Web.Services.Description.MessagePart. An array of names of the System.Web.Services.Description.MessagePart instances to be returned.
MessageBinding class (System.Web.Services.Description)
ToString
Description
Describes how abstract content is mapped into a concrete format. This abstract class forms the base class for the following classes: System.Web.Services.Description.FaultBindingSystem.Web.Services.Description. InputBindingSystem.Web.Services.Description.OutputBinding
MessageBinding
Example Syntax:
ToString
Documentation
Extensions
ToString
Description
Gets the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion associated with the MessageBinding instance.
This property is intended to be overridden to provide the format extensions for Input, Output and Fault messages.
Name
ToString
Gets or sets the name of the System.Web.Services.Description.MessageBinding.
OperationBinding
ToString
Gets the System.Web.Services.Description.OperationBinding of which the MessageBinding instance is a member.
MessageCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.Message objects. This class cannot be inherited.
Count
InnerList
Item
ToString
System.Web.Services.Description.Message
Description
Gets or sets the value of a System.Web.Services.Description.Message at the specified zero-based index. The zero-based index of the Message whose value is modified or returned.
Item
ToString
Gets the Message by its System.Web.Services.Description.Message.Name property. The string value representing the name of the Message returned.
List
Table
Add
Adds the specified System.Web.Services.Description.Message instance to the end of the MessageCollection.
Return Value: Returns the zero-based index where message has been added. The System.Web.Services.Description.Message to be added to the MessageCollection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.Message instance is a member of the MessageCollection.
Return Value: true if message is a member of the MessageCollection; otherwise, false. A System.Web.Services.Description.Message object.
CopyTo
Copies the entire MessageCollection to a compatible one-dimensional array of type System.Web.Services.Description.Message, starting at the specified zero-based index of the target array. The array, of type System.Web.Services.Description.Message, serving as the destination of the copy action. The zero-based index at which to start placing the copied collection.
GetKey
Supplies the name of the System.Web.Services.Description.Message associated with the value passed by reference. A System.Web.Services.Description.Message instance for which to return the name.
IndexOf
Searches for the specified System.Web.Services.Description.Message instance and returns the zero-based index of the first occurrence within the collection.
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.Message object for which to search the MessageCollection.
Insert
Adds the specified System.Web.Services.Description.Message instance to the MessageCollection at the specified index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert message. The System.Web.Services.Description.Message instance to add to the collection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.Message instance from the MessageCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.MessageCollection.Count. A System.Web.Services.Description.Message instance for which to search the collection.
SetParent
Sets the parent System.Web.Services.Description.ServiceDescription of a member of the MessageCollection. An object, of type System.Web.Services.Description.Message, within the collection. The object, of type System.Web.Services.Description.ServiceDescription, to be set as the parent.
MessagePart class (System.Web.Services.Description)
ToString
Description
Allows messages to be broken up into their logical units, with specific abstract information for each part. This class cannot be inherited.
MessagePart
Example Syntax:
ToString
Documentation
Element
ToString
Description
Gets or sets the XML element name of the System.Web.Services.Description.MessagePart instance.
This property corresponds to the attribute of the tag for which the MessagePart class serves as a wrapper.
Message
ToString
Gets the System.Web.Services.Description.Message of which the MessagePart instance is a member.
Name
ToString
Gets or sets the name of the System.Web.Services.Description.MessagePart instance.
Returns an empty string (“ ”) if the property value has not been assigned. This property corresponds to the attribute of the tag for which the MessagePart class serves as a wrapper.
Type
ToString
Gets or sets the XML datatype of the System.Web.Services.Description.MessagePart instance.
This property corresponds to the attribute of the tag for which the MessagePart class serves as a wrapper. In general it refers to an XSD datatype, but can also be extended as long as the XML namespace used is different from that of WSDL.
MessagePartCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.MessagePart objects. This class cannot be inherited.
Count
InnerList
Item
ToString
System.Web.Services.Description.MessagePart
Description
Gets or sets the value of a System.Web.Services.Description.MessagePart at the specified zero-based index. The zero-based index of the MessagePart whose value is modified or returned.
Item
ToString
Gets the MessagePart by its Name property. The string value representing the name of the System.Web.Services.Description.MessagePart returned.
List
Table
Add
Adds the specified System.Web.Services.Description.MessagePart to the end of the System.Web.Services.Description.MessagePartCollection.
Return Value: Returns the index where messagePart has been added. The System.Web.Services.Description.MessagePart to be added to the collection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.MessagePart is a member of the MessagePartCollection.
Return Value: true if messagePart is a member of the MessagePartCollection; otherwise, false. A System.Web.Services.Description.MessagePart object.
CopyTo
Copies the entire MessagePartCollection to a compatible one-dimensional array of type System.Web.Services.Description.MessagePart, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.MessagePart serving as the destination of the copy action. The zero-based index at which to start placing the copied collection.
GetKey
Returns the name of the System.Web.Services.Description.MessagePart associated with the value passed by reference. An object for which to return the name.
IndexOf
Searches for the specified System.Web.Services.Description.MessagePart and returns the zero-based index of the first occurrence within the collection.
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.MessagePart object.
Insert
Adds the specified System.Web.Services.Description.MessagePart to the MessagePartCollection at the specified index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert messagePart. The System.Web.Services.Description.MessagePart to be added to the collection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.MessagePart from the MessagePartCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.MessagePartCollection.Count. A System.Web.Services.Description.MessagePart object.
SetParent
Sets the parent System.Web.Services.Description.Message of a member of System.Web.Services.Description.MessagePartCollection. An object, of type System.Web.Services.Description.MessagePart, within the collection. The object, of type System.Web.Services.Description.Message, to set as the parent.
MimeContentBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to an System.Web.Services.Description.InputBinding or an System.Web.Services.Description.OutputBinding within a Web Service, specifying the MIME format for the body of the HTTP transmission. This class cannot be inherited.
ToString
Specifies the URI for the XML namespace of the MimeContentBinding class. This field is constant.
MimeContentBinding
Example Syntax:
ToString
Handled
Parent
Part
ToString
Description
Gets or sets the name of the System.Web.Services.Description.MessagePart to which the MimeContentBinding applies.
Required
Type
ToString
Description
Gets or sets a value indicating the format of the body of the HTTP transmission.
The WSDL specification defines bindings for several MIME types, including text/xml, multipart/related, and application/x-www-form-urlencoded, although any MIME type may be used. The wildcard character (*) may also be used. For example, the string “text/*” would represent all text types. If the value of this property is not set, the MimeContentBinding specifies all MIME types.
MimeMultipartRelatedBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to an System.Web.Services.Description.InputBinding or an System.Web.Services.Description.OutputBinding, specifying the individual MIME formats for each System.Web.Services.Description.MessagePart within the HTTP transmission. This class cannot be inherited.
MimeMultipartRelatedBinding
Example Syntax:
ToString
Handled
Parent
Parts
ToString
Description
Gets the collection of extensibility elements added to the MimeMultipartRelatedBinding, which specify the MIME format for the corresponding System.Web.Services.Description.MessagePart instances.
Required
MimePart class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to a System.Web.Services.Description.MimeMultipartRelatedBinding, specifying the concrete MIME type for the System.Web.Services.Description.MessagePart to which the MimePart applies. This class cannot be inherited.
MimePart
Example Syntax:
ToString
Extensions
ToString
Gets the collection of bindings for the System.Web.Services.Description.MimeMultipartRelatedBinding of which the MimePart is a member.
This collection must have at least one member. If it has more than one member, then the members are alternative MIME formats for a corresponding System.Web.Services.Description.MessagePart.
Handled
Parent
Required
MimePartCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.MimePart objects. This class cannot be inherited.
MimePartCollection
Example Syntax:
ToString
Count
InnerList
Item
ToString
Description
Gets or sets the value of a System.Web.Services.Description.MimePart at the specified zero-based index. The zero-based index of the MimePart whose value is modified or returned.
List
Add
Adds the specified System.Web.Services.Description.MimePart instance to the end of the MimePartCollection.
Return Value: Returns the zero-based index where mimePart has been added. The System.Web.Services.Description.MimePart to be added to the collection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.MimePart instance is a member of the MimePartCollection.
Return Value: true if mimePart is a member of the MimePartCollection; otherwise, false. A System.Web.Services.Description.MimePart instance.
CopyTo
Copies the entire MimePartCollection to a compatible one-dimensional array of type System.Web.Services.Description.MimePart, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.MimePart serving as the destination of the copy action. The zero-based index at which to start placing the copied collection.
IndexOf
Searches for the specified System.Web.Services.Description.MimePart instance and returns the zero-based index of the first occurrence within the collection.
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.MimePart object for which to search the MimePartCollection.
Insert
Adds the specified System.Web.Services.Description.MimePart instance to the MimePartCollection at the specified index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert mimePart. The System.Web.Services.Description.MimePart to add to the collection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.MimePart from the MimePartCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.MimePartCollection.Count. A System.Web.Services.Description.MimePart instance for which to search the collection.
MimeTextBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to an System.Web.Services.Description.InputBinding, an System.Web.Services.Description.OutputBinding or a System.Web.Services.Description.MimePart, specifying the text patterns for which to search the HTTP transmission. This class cannot be inherited.
ToString
Specifies the URI for the XML namespace of the MimeTextBinding class. This field is constant.
MimeTextBinding
Example Syntax:
ToString
Handled
Matches
ToString
Description
Gets the collection of MIME text patterns for which the HTTP transmission is searched.
Parent
Required
MimeTextMatch class (System.Web.Services.Description)
ToString
Description
Represents a text pattern for which the HTTP transmission is searched. This class cannot be inherited.
MimeTextMatch
Example Syntax:
ToString
Capture
ToString
Returns a 32-bit signed integer. The default value is 0.
Group
ToString
Gets or sets a value indicating the number of groups in which to place the results of the text search.
The value of this property should be less than or equal to the value of the System.Web.Services.Description.MimeTextMatch.Repeats property. It is recommended that developers use the default value.
IgnoreCase
ToString
Gets or sets a value indicating whether the search should disregard the case of the text to be searched.
Matches
ToString
Name
ToString
Gets or sets the name of the MimeTextMatch instance.
Pattern
ToString
Gets or sets the text pattern for the search.
The value of this property can contain wildcard characters.
Repeats
ToString
Gets or sets a value indicating the number of times the search is to be performed.
In a case where there is more than one possible match, a property value of 1 will return only the first match found.
RepeatsString
ToString
Gets or sets a value indicating the number of times the search is to be performed.
This property returns the same information as the System.Web.Services.Description.MimeTextMatch.Repeats property, but as a string rather than a 32-bit signed integer. A value of “*” corresponds to System.Int32.MaxValue.
Type
ToString
Gets or sets a value indicating the MIME format of the text to be searched.
This property returns an empty string (“ ”) if its value has not been set.
MimeTextMatchCollection class (System.Web.Services.Description)
ToString
Description
Provides a collection of System.Web.Services.Description.MimeTextMatch instances. This class cannot be inherited.
MimeTextMatchCollection
Example Syntax:
ToString
Count
InnerList
Item
ToString
Description
Gets or sets the value of a member of the MimeTextMatchCollection at the specified zero-based index. The zero-based index of the MimeTextMatch whose value is returned or modified.
List
Add
Adds the specified System.Web.Services.Description.MimeTextMatch instance to the end of the MimeTextMatchCollection.
Return Value: Returns the zero-based index where match has been added. The System.Web.Services.Description.MimeTextMatch to be added to the collection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.MimeTextMatch instance is a member of the MimeTextMatchCollection.
Return Value: true if match is a member of the MimeTextMatchCollection; otherwise, false. A System.Web.Services.Description.MimeTextMatch instance.
CopyTo
Copies the entire MimeTextMatchCollection to a compatible one-dimensional array of type System.Web.Services.Description.MimeTextMatch, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.MimeTextMatch serving as the destination of the copy action. The zero-based index at which to start placing the copied collection.
IndexOf
Searches for the specified System.Web.Services.Description.MimeTextMatch instance and returns the zero-based index of the first occurrence within the collection.
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.MimeTextMatch object for which to search the MimeTextMatchCollection.
Insert
Adds the specified System.Web.Services.Description.MimeTextMatch instance to the MimeTextMatchCollection at the specified index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert match. The System.Web.Services.Description.MimeTextMatch to add to the collection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.MimeTextMatch instance from the MimeTextMatchCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.MimeTextMatchCollection.Count. A System.Web.Services.Description.MimeTextMatch instance for which to search the collection.
MimeXmlBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to a System.Web.Services.Description.MimePart, an System.Web.Services.Description.InputBinding or an System.Web.Services.Description.OutputBinding. Specifies the schema for XML messages that are not SOAP compliant. This class cannot be inherited.
MimeXmlBinding
Example Syntax:
ToString
Handled
Parent
Part
ToString
Description
Gets or sets the name of the System.Web.Services.Description.MessagePart to which the MimeXmlBinding applies.
Required
Operation class (System.Web.Services.Description)
ToString
Description
Provides an abstract definition of an action supported by the Web Service. This class cannot be inherited.
Exactly one instance of this class will be a member of the System.Web.Services.Description.Operation.Messages property of the parent System.Web.Services.Description.Operation.
Operation
Example Syntax:
ToString
Documentation
Faults
ToString
Description
Gets the collection of faults, or error messages, defined by the System.Web.Services.Description.Operation instance.
Messages
ToString
Gets the collection of System.Web.Services.Description.Message instances defined by the System.Web.Services.Description.Operation instance.
Because an Operation instance is associated with exactly one System.Web.Services.Description.OperationInput and exactly one System.Web.Services.Description.OperationOutput, only one instance of each can be a member of this collection, and thus the collection can have a maximum of two members.
Name
ToString
Gets or sets the name of the System.Web.Services.Description.Operation instance.
Returns an empty string (“ ”) if the property value has not been set.
ParameterOrder
ToString
Gets or sets an array of elements contained in the System.Web.Services.Description.Operation.ParameterOrderString.
Note that the elements of this array are identical to those of the System.Web.Services.Description.Operation.ParameterOrderString, but housed in an array rather than a space-delimited string.
ParameterOrderString
ToString
An optional RPC-signature ordering specification for request/response or solicit/response operations. The value is a list of names of System.Web.Services.Description.MessagePart instances separated by a single space.
The named System.Web.Services.Description.MessagePart instances must adhere to the following rules: The order of the named System.Web.Services.Description.MessagePart instances reflects the order of the parameters in the RPC signature.
PortType
ToString
Gets the System.Web.Services.Description.PortType of which the Operation is a member.
IsBoundBy
Gets a value indicating whether the specified System.Web.Services.Description.OperationBinding is used in the Operation instance.
Return Value: true if the Operation instance uses operationBinding; otherwise, false. An System.Web.Services.Description.OperationBinding instance to be checked to determine whether it is used by the Operation.
OperationBinding class (System.Web.Services.Description)
ToString
Description
Provides specifications for protocols and data formats for the messages used in the action supported by the Web Service. This class cannot be inherited.
This class contains all the System.Web.Services.Description.Binding elements required for the actions supported by the Web Service.
OperationBinding
Example Syntax:
ToString
Binding
ToString
The System.Web.Services.Description.Binding of which the System.Web.Services.Description.OperationBinding instance is a member.
Documentation
Extensions
ToString
Description
Gets the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollection specific to the System.Web.Services.Description.OperationBinding instance.
Faults
ToString
Gets the System.Web.Services.Description.FaultBindingCollection associated with the System.Web.Services.Description.OperationBinding instance.
Input
ToString
Gets or sets the System.Web.Services.Description.InputBinding associated with the System.Web.Services.Description.OperationBinding instance.
An OperationBinding will be associated with exactly one System.Web.Services.Description.InputBinding.
Name
ToString
Gets or sets the name of the OperationBinding instance.
In WSDL format, this property is realized as the name attribute of the tag enclosed within the tags. Note that an empty string (“ ”) is returned if this property value has not been set.
Output
ToString
Gets or sets the System.Web.Services.Description.OutputBinding associated with the System.Web.Services.Description.OperationBinding instance.
An OperationBinding will be associated with exactly one System.Web.Services.Description.OutputBinding.
OperationBindingCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.OperationBinding objects. This class cannot be inherited.
Count
InnerList
Item
ToString
Description
Gets or sets the value of a System.Web.Services.Description.OperationBinding at the specified zero-based index. The zero-based index of the System.Web.Services.Description.OperationBinding whose value is modified or returned.
List
Table
Add
Adds the specified System.Web.Services.Description.OperationBinding instance to the end of the OperationBindingCollection.
Return Value: Returns the zero-based index where bindingOperation has been added. The System.Web.Services.Description.OperationBinding to be added to the collection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.OperationBinding is a member of the OperationBindingCollection.
Return Value: true if bindingOperation is a member of the OperationBindingCollection; otherwise, false. An System.Web.Services.Description.OperationBinding object.
CopyTo
Copies the entire OperationBindingCollection to a compatible one-dimensional array of type System.Web.Services.Description.OperationBinding, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.OperationBinding that serves as the destination for the copy action. The zero-based index at which to start placing the copied collection into the target array.
IndexOf
Searches for the specified System.Web.Services.Description.OperationBinding and returns the zero-based index of the first occurrence within the OperationBindingCollection.
Return Value: Returns a 32-bit signed integer. An System.Web.Services.Description.OperationBinding object.
Insert
Adds the specified System.Web.Services.Description.OperationBinding instance to the OperationBindingCollection at the specified index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert bindingOperation. The System.Web.Services.Description.OperationBinding to be added to the collection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.OperationBinding from the OperationBindingCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.OperationBindingCollection.Count. An System.Web.Services.Description.OperationBinding object.
SetParent
Sets the parent System.Web.Services.Description.Binding of a member of the OperationBindingCollection. An object, of type System.Web.Services.Description.OperationBinding, within the collection. The object, of type System.Web.Services.Description.Binding, to be set as the parent.
OperationCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.Operation objects. This class cannot be inherited.
Count
InnerList
Item
ToString
Description
Gets or sets the value of a System.Web.Services.Description.Operation at the specified zero-based index. The zero-based index of the System.Web.Services.Description.Operation whose value is modified or returned.
List
Table
Add
Adds the specified System.Web.Services.Description.Operation to the end of the OperationCollection.
Return Value: Returns the zero-based index where operation has been added. The System.Web.Services.Description.Operation to be added to the OperationCollection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.Operation is a member of the OperationCollection.
Return Value: true if operation is a member of the OperationCollection; otherwise, false. An System.Web.Services.Description.Operation object.
CopyTo
Copies the entire OperationCollection to a compatible one-dimensional array of type System.Web.Services.Description.Operation, starting at the specified index of the target array. An array of type System.Web.Services.Description.Operation serving as the destination for the copy action. The zero-based index at which to start placing the copied collection.
IndexOf
Searches for the specified System.Web.Services.Description.Operation and returns the zero-based index of the first occurrence within the OperationCollection.
Return Value: Returns a 32-bit signed integer. An System.Web.Services.Description.Operation object.
Insert
Adds the specified System.Web.Services.Description.Operation instance to the OperationCollection at the specified index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert operation. The System.Web.Services.Description.Operation to be added to the OperationCollection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.Operation from the OperationCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.OperationCollection.Count. The System.Web.Services.Description.Operation object to be removed from the Collection.
SetParent
Sets the parent System.Web.Services.Description.PortType of a member of OperationCollection. An object, of type System.Web.Services.Description.Operation, within the OperationCollection. The object, of type System.Web.Services.Description.PortType, to set as the parent.
OperationFault class (System.Web.Services.Description)
ToString
Description
Defines the specifications for error messages returned by the Web Service. This class cannot be inherited.
Instances of this class will be members of the System.Web.Services.Description.Operation.Faults property of the parent Operation.
OperationFault
Example Syntax:
ToString
Documentation
Message
Name
Operation
OperationFaultCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.OperationFault objects. This class cannot be inherited.
Count
InnerList
Item
ToString
System.Web.Services.Description.OperationFault
Description
Gets or sets the value of a System.Web.Services.Description.OperationFault at the specified zero-based index. The zero-based index of the System.Web.Services.Description.OperationFault whose value is modified or returned.
Item
ToString
Gets an System.Web.Services.Description.OperationFault by its System.Web.Services.Description.OperationFault.Name property. The string value representing the name of the System.Web.Services.Description.OperationFault returned.
List
Table
Add
Adds the specified System.Web.Services.Description.OperationFault to the end of the OperationFaultCollection.
Return Value: Returns the zero-based index where operationFaultMessage has been added. The System.Web.Services.Description.OperationFault to be added to the OperationFaultCollection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.OperationFault is a member of the OperationFaultCollection.
Return Value: true if operationFaultMessage is a member of the OperationFaultCollection; otherwise, false. An System.Web.Services.Description.OperationFault object.
CopyTo
Copies the entire System.Web.Services.Description.OperationFaultCollection to a compatible one-dimensional array, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.OperationFault serving as the destination of the copy action. The zero-based index at which to start placing the copied collection.
GetKey
Returns the name of the System.Web.Services.Description.OperationFault associated with the value passed by reference. An object for which to return the name.
IndexOf
Searches for the specified System.Web.Services.Description.OperationFault and returns the zero-based index of the first occurrence within the collection.
Return Value: Returns a 32-bit signed integer. An System.Web.Services.Description.OperationFault object.
Insert
Adds the specified System.Web.Services.Description.OperationFault to the OperationFaultCollection at the specified zero-based index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert operationFaultMessage. The System.Web.Services.Description.OperationFault to be added to the Collection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.OperationFault from the OperationFaultCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.OperationFaultCollection.Count. The System.Web.Services.Description.OperationFault object to be removed from the collection.
SetParent
Sets the parent System.Web.Services.Description.Operation of a member of the OperationFaultCollection. An object, of class System.Web.Services.Description.OperationFault, within the collection. The object, of class System.Web.Services.Description.Operation, to be set as the parent.
OperationFlow enumeration (System.Web.Services.Description)
ToString
Description
Specifies the type of transmission an endpoint of the Web Service can support.
Although Request-Response or Solicit-Response are logically correlated in the WSDL document, the concrete correlation information will be specified by a binding. For example, the request and response messages may be exchanged as part of one or two actual HTTP transmissions.
ToString
Indicates that the endpoint of the Web Service receives no transmissions.
ToString
Indicates that an endpoint of the Web Service sends a message.
ToString
Indicates that the endpoint of the Web Service receives a message.
ToString
Indicates that an endpoint of the Web Service receives a message, then sends a correlated message.
ToString
Indicates that an endpoint of the Web Service sends a message, then receives a correlated message.
OperationInput class (System.Web.Services.Description)
ToString
Description
Defines the specifications for input messages received by the Web Service. This class cannot be inherited.
Exactly one instance of this class will be a member of the System.Web.Services.Description.Operation.Messages property of the parent System.Web.Services.Description.Operation
OperationInput
Example Syntax:
ToString
Documentation
Message
Name
Operation
OperationMessage class (System.Web.Services.Description)
ToString
Description
Serves as the base class for the following classes: System.Web.Services.Description.OperationFaultSystem.Web.Services.Description.OperationlnputSystem.Web.Services.Description.OperationOutput In its default implementation, an OperationMessage instance refers to any message type passed by the action of a service.
OperationMessage
Example Syntax:
ToString
Documentation
Message
ToString
Description
Gets or sets an abstract, typed definition of the data being communicated.
Name
ToString
The name of the System.Web.Services.Description.OperationMessage instance.
Operation
ToString
Gets the System.Web.Services.Description.Operation of which the System.Web.Services.Description.OperationMessage instance is a member.
OperationMessageCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.OperationInput and System.Web.Services.Description.OperationOutput messages related to a Web Service. This class cannot be inherited.
An instance of this class will be returned by the System.Web.Services.Description.Operation.Messages property of the parent System.Web.Services.Description.Operation. As such, it can have exactly two members, one an System.Web.Services.Description.OperationInput and the other an System.Web.Services.Description.OperationOutput.
Count
Flow
ToString
Description
Gets the type of transmission supported by the OperationMessageCollection.
InnerList
Input
ToString
Description
Gets the first occurrence of an System.Web.Services.Description.OperationInput instance within the collection.
Th
Item
ToString
Gets or sets the value of an System.Web.Services.Description.OperationMessage at the specified zero-based index. The zero-based index of the System.Web.Services.Description.OperationMessage whose value is modified or returned.
List
Output
ToString
Description
Gets the first occurrence of an System.Web.Services.Description.OperationOutput within the collection.
The search is performed in index order; thus the property returns only the System.Web.Services.Description.OperationOutput with the lowest-numbered index.
Table
Add
Adds the specified System.Web.Services.Description.OperationMessage to the end of the OperationMessageCollection.
Return Value: Returns the zero-based index where operationMessage has been added. The System.Web.Services.Description.OperationMessage to be added to the collection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.OperationMessage instance is a member of the OperationMessageCollection.
Return Value: true if operationMessage is a member of the OperationMessageCollection; otherwise, false. An System.Web.Services.Description.OperationMessage object.
CopyTo
Copies the entire OperationMessageCollection to a compatible one-dimensional array of type System.Web.Services.Description.OperationMessage, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.OperationMessage serving as the destination of the copy action. The zero-based index at which to start placing the copied collection.
IndexOf
Searches for the specified OperationMessage instance and returns the zero-based index of the first occurrence within the OperationMessageCollection.
Return Value: Returns a 32-bit signed integer. An System.Web.Services.Description.OperationMessage object.
Insert
Adds the specified System.Web.Services.Description.OperationMessage to the OperationMessageCollection at the specified zero-based index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert operationMessage. The System.Web.Services.Description.OperationMessage to be added to the OperationMessageCollection.
OnInsert
Performs validation upon insertion of an System.Web.Services.Description.OperationMessage at the specified specified.
This method overrides the base method in order to limit the number of collection members to two (an System.Web.Services.Description.OperationInput and an System.Web.Services.Description.OperationOutput). The zero-based index at which to insert the specified System.Web.Services.Description.OperationMessage. The System.Web.Services.Description.OperationMessage to be added to the OperationMessageCollection.
OnSet
Performs validation upon replacement of the specified member of the OperationMessageCollection with a new OperationMessage at the specified zero-based index.
This method overrides the base method in order to assure that the value replacing the existing value is of the same class as that existing value. Thus an System.Web.Services.Description.OperationInput must be replaced by an OperationInput, and an System.Web.Services.Description.OperationOutput must be replaced by an OperationOutput. The zero-based index at which to change oldValue to newValue. The object value to be replaced by newValue. The object value with which to replace oldValue.
OnValidate
Performs a check on the type of the specified object when validating it.
This method overrides the base method in order to assure that the instance represented by the value parameter is either of type System.Web.Services.Description.OperationInput or System.Web.Services.Description.OperationOutput. The object to be validated.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.OperationMessage from the OperationMessageCollection.
This method performs a linear search; therefore, the average execution time is proportional to Count. An System.Web.Services.Description.OperationMessage object.
SetParent
Sets the parent System.Web.Services.Description.Operation of the OperationMessageCollection. An object, of type System.Web.Services.Description.OperationMessage or a derived type, within the collection. The object, of type System.Web.Services.Description.Operation, to be set as the parent.
OperationOutput class (System.Web.Services.Description)
ToString
Description
Defines the specifications for output messages returned by the Web Service. This class cannot be inherited.
Exactly one instance of this class will be a member of the System.Web.Services.Description.Operation.Messages property of the parent System.Web.Services.Description.Operation
OperationOutput
Example Syntax:
ToString
Documentation
Message
Name
Operation
OutputBinding class (System.Web.Services.Description)
ToString
Description
Provides a set of specifications for data formats and protocols used by the Web Service for output messages. This class cannot be inherited.
OutputBinding
Example Syntax:
ToString
Documentation
Extensions
ToString
Description
Gets the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollection associated with the OutputBinding instance.
Name
OperationBinding
Port class (System.Web.Services.Description)
ToString
Description
Defines an individual endpoint contained in the Web Service. This class cannot be inherited.
This class specifies a single address (URI) for a binding, which defines message format and protocol details for operations and messages for a given System.Web.Services.Description.PortType. The System.Web.Services.Description.Port.Binding property gets or sets those values for the Port instance.
Port
Example Syntax:
ToString
Binding
ToString
Gets or sets the value of the XML binding attribute of the Port.
A binding defines message format and protocol details for operations and messages for a given System.Web.Services.Description.PortType. This property gets or sets those values for a specific Port.
Documentation
Extensions
ToString
Description
Gets the collection of extensibility elements contained in the Port.
Name
ToString
Gets or sets the Name of the Port
Service
ToString
Gets the System.Web.Services.Description.Service of which the Port instance is a member.
PortCollection class (System.Web.Services.Description)
ToString
Description
Represents the collection of all System.Web.Services.Description.Port objects contained within a System.Web.Services.Description.Service. This class cannot be inherited.
Count
InnerList
Item
ToString
System.Web.Services.Description.Port
Description
Gets or sets the value of a System.Web.Services.Description.Port at the specified zero-based index. The zero-based index of the System.Web.Services.Description.Port whose value is modified or returned.
Item
ToString
Gets the specified System.Web.Services.Description.Port by its System.Web.Services.Description.Port.Name property. A string value representing the name of the System.Web.Services.Description.Port returned.
List
Table
Add
Adds the specified System.Web.Services.Description.Port instance to the end of the PortCollection.
Return Value: Returns the index where the specified System.Web.Services.Description.Port instance has been added. The System.Web.Services.Description.Port to be added to the PortCollection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.Port instance is a member of the PortCollection.
Return Value: true if the specified System.Web.Services.Description.Port is a member of the PortCollection; otherwise, false. A System.Web.Services.Description.Port object.
CopyTo
Copies the entire System.Web.Services.Description.PortCollection to a one-dimensional array of type System.Web.Services.Description.Port, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.Port serving as the destination of the copy action. The zero-based index at which to start placing the copied PortCollection.
GetKey
Returns the name of the System.Web.Services.Description.Port instance associated with the value passed by reference. A System.Web.Services.Description.Port instance for which to return the name.
IndexOf
Searches for the specified System.Web.Services.Description.Port instance and returns the zero-based index of the first occurrence within the PortCollection.
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.Port object.
Insert
Adds the specified System.Web.Services.Description.Port instance to the PortCollection at the specified index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert port. The System.Web.Services.Description.Port to be added to the collection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.Port from the PortCollection.
This method performs a linear search; therefore, the average execution time is proportional to Count. A System.Web.Services.Description.Port object.
SetParent
Sets the parent System.Web.Services.Description.Service of a member of the PortCollection. An object, of type System.Web.Services.Description.Port, within the collection. The object, of type System.Web.Services.Description.Service, to set as the parent.
PortType class (System.Web.Services.Description)
ToString
Description
Represents a named set of abstract operations and the corresponding abstract messages. This class cannot be inherited.
PortType
Example Syntax:
ToString
Documentation
Name
ToString
Description
Gets or sets the name of the System.Web.Services.Description.PortType instance.
Returns an empty string (“ ”) if the property value has not been assigned.
Operations
ToString
Gets the collection of System.Web.Services.Description.Operation instances defined by the System.Web.Services.Description.PortType instance.
ServiceDescription
ToString
Gets the System.Web.Services.Description.ServiceDescription of which the System.Web.Services.Description.PortType instance is a member.
PortTypeCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.PortType objects, that is, a collection of sets of operations supported by the Web Service. This class cannot be inherited.
Count
InnerList
Item
ToString
System.Web.Services.Description.PortType
Description
Gets or sets the value of a System.Web.Services.Description.PortType at the specified zero-based index. The zero-based index of the System.Web.Services.Description.PortType whose value is modified or returned.
Item
ToString
Gets the specified System.Web.Services.Description.PortType by its System.Web.Services.Description.PortType.Name property.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.PortTypeCollection.Count. The string value representing the name of the System.Web.Services.Description.PortType returned.
List
Table
Add
Adds the specified System.Web.Services.Description.PortType to the end of the PortTypeCollection.
Return Value: Returns the index where the System.Web.Services.Description.PortType instance specified by the portType parameter has been added. The System.Web.Services.Description.PortType to be added to the PortTypeCollection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.PortType instance is a member of the PortTypeCollection.
Return Value: true if the specified System.Web.Services.Description.PortType instance is a member of the PortTypeCollection; otherwise, false. A System.Web.Services.Description.PortType object.
CopyTo
Copies the entire System.Web.Services.Description.PortTypeCollection to a one-dimensional array of type PortType, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.PortType serving as the destination of the copy action. The zero-based index at which to start placing the copied PortTypeCollection.
GetKey
Returns the name of the System.Web.Services.Description.PortType associated with the value passed by reference. An object for which to return the name.
IndexOf
Searches for the specified System.Web.Services.Description.PortType instance and returns the zero-based index of the first occurrence within the PortTypeCollection.
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.PortType object.
Insert
Adds the specified System.Web.Services.Description.PortType instance to the PortTypeCollection at the specified zero-based index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert the specified System.Web.Services.Description.PortType instance. The System.Web.Services.Description.PortType to be added to the PortTypeCollection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.PortType from the PortTypeCollection.
This method performs a linear search; therefore, the average execution time is proportional to Count. A System.Web.Services.Description.PortType object.
SetParent
Sets the parent System.Web.Services.Description.ServiceDescription of a member of System.Web.Services.Description.PortTypeCollection. An object, of type System.Web.Services.Description.PortType, within the PortTypeCollection. The object, of type System.Web.Services.Description.ServiceDescription, to set as the parent.
ProtocolImporter class (System.Web.Services.Description)
ToString
Description
ProtocolImporter
Example Syntax:
ToString
AbstractSchemas
ToString
Binding
ToString
ClassName
ToString
ClassNames
ToString
CodeNamespace
ToString
CodeTypeDeclaration
ToString
ConcreteSchemas
ToString
InputMessage
ToString
MethodName
ToString
Operation
ToString
OperationBinding
ToString
OutputMessage
ToString
Port
ToString
PortType
ToString
ProtocolName
ToString
Schemas
ToString
Service
ToString
ServiceDescriptions
ToString
Style
ToString
Warnings
ToString
AddExtensionWarningComments
BeginClass
BeginNamespace
EndClass
EndNamespace
GenerateMethod
IsBindingSupported
IsOperationFlowSupported
OperationBindingSyntaxException
OperationSyntaxException
UnsupportedBindingWarning
UnsupportedOperationBindingWarning
UnsupportedOperationWarning
ProtocolReflector class (System.Web.Services.Description)
UnsupportedOperationWarning
Description
ProtocolReflector
Example Syntax:
UnsupportedOperationWarning
Binding
UnsupportedOperationWarning
DefaultNamespace
UnsupportedOperationWarning
HeaderMessages
UnsupportedOperationWarning
InputMessage
UnsupportedOperationWarning
Method
UnsupportedOperationWarning
MethodAttribute
UnsupportedOperationWarning
Methods
UnsupportedOperationWarning
Operation
UnsupportedOperationWarning
OperationBinding
UnsupportedOperationWarning
OutputMessage
UnsupportedOperationWarning
Port
UnsupportedOperationWarning
PortType
UnsupportedOperationWarning
ProtocolName
UnsupportedOperationWarning
ReflectionImporter
UnsupportedOperationWarning
SchemaExporter
UnsupportedOperationWarning
Schemas
UnsupportedOperationWarning
Service
UnsupportedOperationWarning
ServiceDescription
UnsupportedOperationWarning
ServiceDescriptions
UnsupportedOperationWarning
ServiceType
UnsupportedOperationWarning
ServiceUrl
UnsupportedOperationWarning
BeginClass
EndClass
GetServiceDescription
ReflectMethod
ReflectMethodBinding
Service class (System.Web.Services.Description)
ToString
Description
Groups together a set of related System.Web.Services.Description.Port instances associated with a Web Service. This class cannot be inherited.
Service
Example Syntax:
ToString
Documentation
Extensions
ToString
Description
Gets the collection of extensibility elements contained in the System.Web.Services.Description.Service instance.
This property will generally only be populated with members if the members of the System.Web.Services.Description.Service.Ports property lack extensibility elements.
Name
ToString
Gets or sets the name of the System.Web.Services.Description.Service instance.
Ports
ToString
Gets the collection of System.Web.Services.Description.Port instances contained in the System.Web.Services.Description.Service instance.
ServiceDescription
ToString
Gets the System.Web.Services.Description.ServiceDescription of which the Service instance is a member.
ServiceCollection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.Service objects. This class cannot be inherited.
Count
InnerList
Item
ToString
System.Web.Services.Description.Service
Description
Gets or sets the value of a System.Web.Services.Description.Service at the specified zero-based index. The zero-based index of the Service to be modified or returned.
Item
ToString
Gets the Service instance by the value of its System.Web.Services.Description.Service.Name property. The string value representing the name of the System.Web.Services.Description.Service returned.
List
Table
Add
Adds the specified System.Web.Services.Description.Service instance to the end of the ServiceCollection.
Return Value: Returns the zero-based index where service has been added. The System.Web.Services.Description.Service instance to be added to the ServiceCollection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.Service instance is a member of the ServiceCollection.
Return Value: true if the specified System.Web.Services.Description.Service instance is a member of the ServiceCollection; otherwise, false. A System.Web.Services.Description.Service object.
CopyTo
Copies the entire ServiceCollection to a one-dimensional array of type System.Web.Services.Description.Service, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.Service serving as the destination of the copy action. The zero-based index at which to start placing the copied ServiceCollection.
GetKey
Returns the name of the System.Web.Services.Description.Service associated with the value passed by reference. An object for which to return the name.
IndexOf
Searches for the specified System.Web.Services.Description.Service instance and returns the zero-based index of the first occurrence within the ServiceCollection.
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.Service object.
Insert
Adds the specified System.Web.Services.Description.Service instance to the ServiceCollection at the specified zero-based index.
If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert the specified System.Web.Services.Description.Service. The System.Web.Services.Description.Service instance to be added to the ServiceCollection.
Remove
Removes the first occurrence of the specified System.Web.Services.Description.Service from the ServiceCollection.
This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.ServiceCollection.Count. A System.Web.Services.Description.Service object.
SetParent
Sets the parent System.Web.Services.Description.ServiceDescription of a member of System.Web.Services.Description.ServiceCollection. An object, of type System.Web.Services.Description.Service, within the ServiceCollection. The object, of type System.Web.Services.Description.ServiceDescription, to be set as the parent.
ServiceDescription class (System.Web.Services.Description)
ToString
Description
Provides a means of creating and formatting a valid WSDL (XML) document file, complete with appropriate namespaces, elements and attributes, for describing a Web Service. This class cannot be inherited.
Instances of this class can be created with either the new keyword or the static System.Web.Services.Description.ServiceDescription.Read(System.IO.TextReader) method, which parses a WSDL (Web Service Description Language) file and assigns its values to appropriate members of the class.
ToString
The XML namespace in which the ServiceDescription class is defined (“http://schemas.xmlsoap.org/wsdl/”). This field is constant.
ServiceDescription
Example Syntax:
ToString
Bindings
ToString
Represents the collection of System.Web.Services.Description.Binding elements that the System.Web.Services.Description.ServiceDescription contains.
Documentation
Extensions
ToString
Description
Gets the collection of extensibility elements that the System.Web.Services.Description.ServiceDescription contains.
Imports
ToString
Gets the collection of System.Web.Services.Description.Import elements that the System.Web.Services.Description.ServiceDescription contains.
Messages
ToString
The collection of System.Web.Services.Description.Message elements the System.Web.Services.Description.ServiceDescription contains.
Name
ToString
Gets or sets the XML Name attribute of the Descriptions tag enclosing the WSDL file.
Returns an empty string (“ ”) if this property value has not been assigned.
PortTypes
ToString
The collection of System.Web.Services.Description.PortType elements the System.Web.Services.Description.ServiceDescription contains.
RetrievalUrl
ToString
Serializer
ToString
ServiceDescriptions
ToString
The System.Web.Services.Description.ServiceDescription Collection instance of which the System.Web.Services.Description.ServiceDescription is a member.
This property is read-only.
Services
ToString
Gets the collection of System.Web.Services.Description.Service instances that the System.Web.Services.Description.ServiceDescription contains.
TargetNamespace
ToString
Gets or sets the XML targetNamespace attribute of the Descriptions tag enclosing a WSDL file.
Types
ToString
Gets or sets the System.Web.Services.Description.Types contained by the ServiceDescription instance.
CanRead
Gets a value indicating whether an System.Xml.XmlReader represents a valid WSDL file that can be parsed.
Return Value: True if the System.Xml.Serialization.XmlSerializer can recognize the node on which the System.Xml.XmlReader is positioned; otherwise false. An System.Xml.XmlReader
Read
Initializes an instance of a System.Web.Services.Description.ServiceDescription object by directly loading the XML from a System.IO.Stream instance.
Return Value: Returns a System.Web.Services.Description.ServiceDescription object. A System.IO.Stream object, passed by reference, that contains the bytes to be read in.
Read
Initializes an instance of a System.Web.Services.Description.ServiceDescription object by directly loading the XML from the specified file.
Return Value: Returns a System.Web.Services.Description.ServiceDescription object. A string representing the path to the file to be read in.
Read
Initializes an instance of a System.Web.Services.Description.ServiceDescription object by directly loading the XML from a System.IO.TextReader instance.
Return Value: Returns a System.Web.Services.Description.ServiceDescription object. A System.IO.TextReader object, passed by reference, that contains the text to be read in.
Read
Initializes an instance of a System.Web.Services.Description.ServiceDescription object by directly loading the XML from an System.Xml.XmlReader instance.
Return Value: Returns a System.Web.Services.Description.ServiceDescription object. An System.Xml.XmlReader instance, passed by reference, that contains the XML data to be read in.
Write
Writes out the System.Web.Services.Description.ServiceDescription to the specified System.IO.Stream instance. A System.IO.Stream, passed by reference, that contains the WSDL file produced.
Write
Writes out the System.Web.Services.Description.ServiceDescription as a WSDL file to the specified path. A string representing the physical path to which the WSDL file is written.
Write
Writes out the System.Web.Services.Description.ServiceDescription to the System.IO.TextWriter instance. A System.IO.TextWriter instance.
Write
Writes out the System.Web.Services.Description.ServiceDescription to the System.Xml.XmlWriter as a WSDL file. An System.Xml.XmlWriter, passed by reference, that contains the WSDL file produced.
ServiceDescription BaseCollection class (System.Web.Services.Description)
Write
Description
Forms the basis for the strongly typed collections that are members of the System.Web.Services.Description namespace.
Count
InnerList
List
Table
Write
Description
Gets an interface that implements the association of the keys and values in the System.Web.Services.Description.ServiceDescription BaseCollection instance.
The default implementation returns a System.Collections.Hashtable to associate the keys and values. This protected method is accessible only through this class or a derived class.
GetKey
Returns the name of the key associated with the value passed by reference.
The default implementation of this method is intended to be overridden by a derived class to return the name of the key associated with value. Note that the default implementation returns null ( Nothing in Visual Basic). This protected method is accessible only through this class or a derived class. An object for which to return the name of the key.
OnClear
Clears the contents of the System.Web.Services.Description.ServiceDescription BaseCollection instance.
This method is intended to be overridden to perform additional processes when clearing the contents of a derived Collection. This protected method is accessible only through this class or a derived class.
OnInsertComplete
Performs additional custom processes when inserting a new element into the System.Web.Services.Description.ServiceDescription BaseCollection instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action when the specified element is inserted. The zero-based index at which to insert the object represented by the value parameter. The new value of the element at the specified zero-based index.
OnRemove
Removes an element from the System.Web.Services.Description.ServiceDescription BaseCollection instance.
This method is intended to be overridden to perform additional processes when an element is removed from the ServiceDescription BaseCollection instance. The zero-based index at which the object represented by the value parameter can be found. The object to remove from the collection.
OnSet
Replaces one value with another within the System.Web.Services.Description.ServiceDescription BaseCollection instance.
The default implementation of this method is intended to be overridden to perform additional processes when setting the value of an element in the ServiceDescription BaseCollection instance. This protected method is accessible only through this class or a derived class. The zero-based index where the object represented by the oldValue parameter can be found. The object to replace with the object represented by the new Value parameter. The object that replaces the object represented by the oldValue parameter.
SetParent
Sets the Parent property of the System.Web.Services.Description.ServiceDescription BaseCollection instance.
The default implementation of this method is intended to be overridden by a derived class to set a parent of an appropriate class. Note also that the default implementation performs no action. This protected method is accessible only through this class or a derived class. The object for which to set the parent object. The object to set as the parent.
ServiceDescription Collection class (System.Web.Services.Description)
ToString
Description
Represents a collection of System.Web.Services.Description.ServiceDescription instances. This class cannot be inherited.
ServiceDescription Collection
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Description.ServiceDescription Collection class.
Count
InnerList
Item
ToString
System.Web.Services.Description.ServiceDescription
Description
Gets or sets the value of a System.Web.Services.Description.ServiceDescription at the specified zero-based index. The zero-based index of the System.Web.Services.Description.ServiceDescription whose value is modified or returned.
Item
ToString
Gets a System.Web.Services.Description.ServiceDescription specified by its System.Web.Services.Description.ServiceDescription.TargetNamespace property. The namespace of the System.Web.Services.Description.ServiceDescription to be returned.
List
Table
Add
Adds the specified System.Web.Services.Description.ServiceDescription to the end of the ServiceDescription Collection.
Return Value: Returns the zero-based index where the specified System.Web.Services.Description.ServiceDescription instance has been added. The System.Web.Services.Description.ServiceDescription to be added to the collection.
Contains
Gets a value indicating whether the specified System.Web.Services.Description.ServiceDescription instance is a member of the collection.
Return Value: true if the specified ServiceDescription instance is a member of the ServiceDescription Collection; otherwise false. A System.Web.Services.Description.ServiceDescription object.
CopyTo
Copies the entire ServiceDescription Collection to a one-dimensional array of type System.Web.Services.Description.ServiceDescription, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.ServiceDescription serving as the destination of the copy action. The zero-based index at which to start placing the copied collection.
GetBinding
Searches the ServiceDescription Collection and returns the System.Web.Services.Description.Binding instance with the specified name that is a member of one of the System.Web.Services.Description.ServiceDescription instances contained in the collection.
Return Value: A Binding object. The System.Xml.XmlQualifledName, passed by reference, whose Name property is shared by the System.Web.Services.Description.Binding returned.
GetKey
Returns the System.Web.Services.Description.ServiceDescription.TargetNamespace property of the System.Web.Services.Description.ServiceDescription associated with the value passed by reference. The object for which to return the TargetNamespace.
GetMessage
Searches the ServiceDescription Collection and returns the System.Web.Services.Description.Message instance with the specified name that is a member of one of the System.Web.Services.Description.ServiceDescription instances contained in the collection.
Return Value: A System.Web.Services.Description.Message object. The System.Xml.XmlQualifledName, passed by reference, whose Name property is shared by the System.Web.Services.Description.Message returned.
GetPortType
Searches the ServiceDescription Collection and returns the System.Web.Services.Description.PortType instance with the specified name that is a member of one of the System.Web.Services.Description.ServiceDescription instances contained in the collection.
Return Value: A System.Web.Services.Description.PortType object. The System.Xml.XmlQualifledName, passed by reference, whose Name property is shared by the System.Web.Services.Description.PortType returned.
GetService
Searches the ServiceDescription Collection and returns the System.Web.Services.Description.Service instance with the specified name that is a member of one of the System.Web.Services.Description.ServiceDescription instances contained in the collection.
Return Value: A System.Web.Services.Description.Service object. The System.Xml.XmlQualifledName, passed by reference, whose Name property is shared by the System.Web.Services.Description.Service returned.
IndexOf
Searches for the specified System.Web.Services.Description.ServiceDescription instance and returns the zero-based index of the first occurrence within the ServiceDescription Collection
Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.ServiceDescription object.
Insert
Adds the specified System.Web.Services.Description.ServiceDescription instance to the ServiceDescription Collection at the specified index. The zero-based index at which to insert the specified System.Web.Services.Description.ServiceDescription. The System.Web.Services.Description.ServiceDescription to add to the collection.
Remove
Removes the first occurrence of a System.Web.Services.Description.ServiceDescription instance specified by the serviceDescription parameter from the ServiceDescription Collection.
This method performs a linear search; therefore, the average execution time is proportional to Count. The System.Web.Services.Description.ServiceDescription to be removed from the collection.
ServiceDescriptionFormatExtension class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to a Web Service.
In a derived class, the ServiceDescriptionFormatExtension class allows users to define extensibility elements in addition to those defined in the WSDL specification. Note that extensibility elements can be added to a ServiceDescription at any of several levels. Thus multiple classes derived from the System.Web.Services.Description.DocumentableItem class (including the System.Web.Services.Description.ServiceDescription class) have an Extensions property, which returns a System.Web.Services.Description.ServiceDescriptionFormatExtensionCollection.
ServiceDescriptionFormatExtension
Example Syntax:
ToString
Handled
ToString
Gets or sets a value indicating whether the System.Web.Services.Description.ServiceDescriptionFormatExtension is handled by the action to which it refers.
Parent
ToString
Gets the parent object of the System.Web.Services.Description.ServiceDescriptionFormatExtension
When overridden in a derived class, the class returned by this property will be a derived class rather than the base System.Object class.
Required
ToString
Gets or sets a value indicating whether the System.Web.Services.Description.ServiceDescriptionFormatExtension is necessary for the action to which it refers.
ServiceDescriptionFormatExtensionCollection class (System.Web.Services.Description)
ToString
Description
Represents the collection of extensibility elements used by the Web Service. This class cannot be inherited.
ServiceDescriptionFormatExtensionCollection
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion class. The System.Web.Services.Description.ServiceDescription of which this collection is a member.
Count
InnerList
Item
ToString
Description
Gets or sets the value of a member of the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion. The zero-based index of the member in question.
List
Table
Add
Adds extension to the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion.
Return Value: Returns the index value of the member added. The System.Web.Services.Description.ServiceDescriptionFormatExtension, passed by reference, to be added to the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion.
Contains
Gets a value indicating whether extension is a member of the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion.
Return Value: true if the object is a member of the collection; otherwise, false. The object that is to be checked whether it is a member of the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion.
CopyTo
Copies the elements in the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion into array, starting at index. The destination of the copy action The zero-based index at which to place the first copied element
Find
This method searches the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion and returns the first instance of type that it discovers.
Return Value: Returns an object of the specified System.Type if its search was successful; null otherwise.
Note that this method searches the collection in index order, and returns only the type with the lowest-numbered index. A System.Type for which to search the collection.
Find
This method searches the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion for a member with name name and namespace URI ns.
Return Value: Returns an System.Xml.XmlElement if the search is successful; otherwise null.
Note that this method searches the collection in index order, and will return the first System.Xml.XmlElement that meets the criteria of the two parameters. A string representing the name of the System.Xml.XmlElement to be found. A string representing the XML namespace URI of the System.Xml.XmlElement to be found.
FindAll
This method searches the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion and returns an array of object instances of System.Typetype that it discovers.
Return Value: Returns an array of System.Object instances.
The array returned will be empty if the search is unsuccessful. A System.Type for which to search the collection.
FindAll
This method searches the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion for members with name name and namespace URI ns.
Return Value: Returns an array of System.Xml.XmlElement objects.
The array returned will be empty if the search is unsuccessful. A string representing the name attribute of the System.Xml.XmlElement objects to be found. A string representing the XML namespace URI attribute of the System.Xml.XmlElement objects to be found.
IndexOf
Gets the zero-based index value of extension, the specified member of the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion.
Return Value: Returns a 32-bit signed integer. The object for which to return the index value.
Insert
Adds extension to the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion at the specified index. The zero-based index at which to add the new member. The object to add to the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollection.
IsHandled
Gets a value indicating whether item is handled.
Return Value: true if item is handled; otherwise false. An object, either of type System.Xml.XmlElement or System.Web.Services.Description.ServiceDescriptionFormatExtension.
IsRequired
Gets a value indicating whether item is required.
Return Value: true if item is required; otherwise false. An object, either of type System.Xml.XmlElement or System.Web.Services.Description.ServiceDescriptionFormatExtension.
OnValidate
Performs a check on the System.Type of value when validating it.
This method overrides the base method in order to determine that value is one of the two valid classes, System.Xml.XmlElement or System.Web.Services.Description.ServiceDescriptionFormatExtension. The object to be validated.
Remove
Removes the first occurrence of extension from the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollection. The object to be removed from the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollection.
SetParent
Sets the parent object of a member of the System.Web.Services.Description.ServiceDescription FormatExtensionCollection.
This method overrides the base method in order to determine that value is of type System.Web.Services.Description.ServiceDescriptionFormatExtension. A child object for which to set the parent. The object to be set as parent.
ServiceDescriptionImporter class (System.Web.Services.Description)
ToString
Description
This class exposes methods for generating client proxy classes for Web Services.
ServiceDescriptionImporter
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Description.ServiceDescriptionImporter class.
ProtocolName
ToString
Gets or sets the name of the protocol to be imported.
Schemas
ToString
Gets the System.Xml.Serialization.XmlSchemas Collection contained in the Web Service to be imported. This property is read-only.
ServiceDescriptions
ToString
Gets the System.Web.Services.Description.ServiceDescription Collection being imported by the ServiceDescriptionImporter.
As with any collection that forms a read-only property, members can be added to the collection, removed from the collection, or modified using the methods exposed by the collection. However, it is recommended that the developer use the System.Web.Services.Description.ServiceDescriptionImporter.AddServiceDescription(System.Web.Services.Description.ServiceDescription,System. String,System.String) method to add members to this collection.
Style
ToString
Gets or sets the System.Web.Services.Description.ServiceDescriptionImportStyle associated with the System.Web.Services.Description.ServiceDescriptionImporter instance.
AddServiceDescription
Adds the specified System.Web.Services.Description.ServiceDescription to the System.Web.Services.Description.ServiceDescriptionImporter.ServiceDescriptions collection. It also sets the System.Web.Services.Description.ServiceDescription.AppSettingUrlKey and System.Web.Services.Description.ServiceDescription.AppSettingBaseUrl properties of the System.Web.Services.Description.ServiceDescription to be added.
The two string parameters, appSettingUrlKey and appSettingBaseUrl, specify how the Url property of the Web Service proxy to be generated from the imported serviceDescription should be constructed. The System.Web.Services.Description.ServiceDescription instance to add to the collection Sets the initial value of the Url property of the proxy class to be generated from the instance represented by the serviceDescription parameter. Specifies that it should be generated from the web.config file's section. Sets the initial value of the Url property of the proxy class to be generated from the instance represented by the serviceDescription parameter. Specifies that it should be constructed from a combination of the value of this parameter and the URL specified by the location attribute in the WSDL document.
Import
Imports a System.Web.Services.Description.ServiceDescription from the specified namespace, and generates code for client proxy classes.
Return Value: One of the System.Web.Services.Description.ServiceDescriptionImportWarnings values.
This method actually does the work of importing System.Web.Services.Description.ServiceDescriptions and System.Xml.Schema.XmlSchemas. A System.CodeDom.CodeNamespace instance that determines the namespace of the System.Web.Services.Description.ServiceDescription to be imported. A System.CodeDom.CodeCompileUnit instance that will add references to the appropriate assemblies.
ServiceDescriptionImportStyle enumeration (System.Web.Services.Description)
ToString
Description
Specifies whether the Import is made to the server or the client machine.
ToString
Specifies that the Import should be made to the client machine.
ToString
Specifies that the Import should be made to the server.
ServiceDescriptionImportWarnings enumeration (System.Web.Services.Description)
ToString
Description
Specifies the type of warnings produced by System.Web.Services.Description.ServiceDescriptionImporter.Import(System.CodeDom.CodeNamespace,System.CodeDom.CodeCompileUnit).
ToString
Specifies that no proxy class was generated by the System.Web.Services.Description.ServiceDescriptionImporter.Import(System.CodeDom.CodeNamespace,System.CodeDom.CodeCompileUnit) method.
ToString
Specifies that the proxy class generated by the System.Web.Services.Description.ServiceDescriptionImporter.Import(System.CodeDom.CodeNamespace,System.CodeDom.CodeCompileUnit) method includes no methods.
ToString
Specifies that at least one optional System.Web.Services.Description.ServiceDescriptionFormatExtension for the System.Web.Services.Description.ServiceDescription to be imported has been ignored.
ToString
Specifies that at least one necessary System.Web.Services.Description.ServiceDescriptionFormatExtension for the System.Web.Services.Description.ServiceDescription to be imported has been ignored.
ToString
Specifies that at least one System.Web.Services.Description.Binding for the System.Web.Services.Description.ServiceDescription to be imported is of an unsupported type and has been ignored.
ToString
Specifies that at least one System.Web.Services.Description.Operation for the System.Web.Services.Description.ServiceDescription to be imported is of an unsupported type and has been ignored.
ServiceDescriptionReflector class (System.Web.Services.Description)
ToString
Description
ServiceDescriptionReflector
Example Syntax:
ToString
Schemas
ToString
ServiceDescriptions
ToString
Reflect
SoapAddressBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to a System.Web.Services.Description.Port within a Web Service. This class cannot be inherited.
SoapAddressBinding
Example Syntax:
ToString
Handled
Location
ToString
Description
Gets or sets a value representing the URI for the System.Web.Services.Description.Port to which the SoapAddressBinding applies.
Parent
Required
SoapBinding class (System.Web.Services.Description)
ToString
Description
Represents an extension added to a System.Web.Services.Description.Binding within a Web Service. It specifies that the data transmission will use SOAP (Simple Object Access Protocol). This class cannot be inherited.
ToString
ToString
Gets the URI (http://schemas.xmlsoap.org/wsdl/soap/) for the XML namespace of the SoapBinding class. This field is constant.
SoapBinding
Example Syntax:
ToString
Handled
Parent
Required
Style
ToString
Description
Specifies the type of SOAP binding used by the SoapBinding instance.
Transport
ToString
Gets or sets the URI for the specification for HTTP transmission of SOAP data.
In general usage, this required property value will be the same as that of the System.Web.Services.Description.SoapBinding.HttpTransport field. However, this property value may be any URI for data-transmission specifications, such as SMTP, FTP, etc.
SoapBindingStyle enumeration (System.Web.Services.Description)
ToString
Description
Specifies the type of action that occurs in the Web Service at the level to which this enumeration is applied.
This enumeration allows the user to specify whether the message being transmitted is procedure- or document-oriented. Procedure-oriented messages contain parameters and return values, while document-oriented messages contain documents.
ToString
This value specifies that the action should use the default value appropriate to that level of the WSDL file.
ToString
Specifies that the message to be transmitted contains documents.
ToString
Specifies that the message to be transmitted contains a call to a procedure. RPC is an acronym for “remote procedure call.”
SoapBindingUse enumeration (System.Web.Services.Description)
ToString
Description
Specifies whether the message parts are encoded using given rules, or define a concrete schema for the message.
ToString
Specifies an empty string (“ ”) value for the corresponding XML attribute.
ToString
Specifies that the message parts are encoded using given encoding rules.
ToString
Specifies that the message parts represent a concrete schema.
SoapBodyBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to an System.Web.Services.Description.InputBinding or an System.Web.Services.Description.OutputBinding. It specifies how messages, either abstract type definitions or concrete schema definitions, appear within the SOAP body element of the transmission. This class cannot be inherited.
SoapBodyBinding
Example Syntax:
ToString
Encoding
ToString
Supplies a list of space-delimited URIs representing the encoding style (or styles) to be used to encode the messages within the SOAP body.
The value of this property should be set only if the value of the System.Web.Services.Description.SoapBodyBinding.Use property is Encoded.
Handled
Namespace
ToString
Description
Get or sets the URI for encoding of content not specifically defined by the System.Web.Services.Description.SoapBodyBinding.Encoding property.
This property will return an empty string (“ ”) if the property value has not been set. The value should only be set if the value of the System.Web.Services.Description.SoapBodyBinding.Use property is Encoded.
Parent
Parts
ToString
Description
Indicates which parts of the transmitted message appear somewhere within the SOAP body portion of that transmission.
Some parts of the transmitted message can appear in portions other than the SOAP body, such as when SOAP is used with a System.Web.Services.Description.MimeMultipartRelatedBinding.
PartsString
ToString
Indicates which parts of the transmitted message appear somewhere within the SOAP body portion of that transmission.
Some parts of the transmitted message can appear in portions other than the SOAP body, such as when SOAP is used with a System.Web.Services.Description.MimeMultipartRelatedBinding.
Required
Use
ToString
Description
Indicates whether the message parts are encoded based on specified encoding rules, or define the concrete schema of the message.
The System.Web.Services.Description.SoapBodyBinding.Namespace and System.Web.Services.Description.SoapBodyBinding.Encoding properties depend on the value of this property. Their values should be set only if the value of this property is Encoded.
SoapExtensionImporter class (System.Web.Services.Description)
ToString
Description
SoapExtensionImporter
Example Syntax:
ToString
ImportContext
ToString
ImportMethod
SoapExtensionReflector class (System.Web.Services.Description)
ToString
Description
SoapExtensionReflector
Example Syntax:
ToString
ReflectionContext
ToString
ReflectMethod
SoapFaultBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to a System.Web.Services.Description.FaultBinding within a Web Service. It specifies the contents of any SOAP fault message returned. This class cannot be inherited.
SoapFaultBinding
Example Syntax:
ToString
Encoding
ToString
Gets or sets a URI representing the encoding style used to encode the SOAP fault message.
The value of this property should be set only if the value of the System.Web.Services.Description.SoapFaultBinding.Use property is Encoded.
Handled
Namespace
ToString
Description
Get or sets the URI for encoding of content not specifically defined by the System.Web.Services.Description.SoapFaultBinding.Encoding property.
This property will return an empty string (“ ”) if the property value has not been set. The value should only be set if the value of the System.Web.Services.Description.SoapFaultBinding.Use property is Encoded.
Parent
Required
Use
ToString
Description
Specifies whether the fault message is encoded using encoding rules specified by the System.Web.Services.Description.SoapFaultBinding.Encoding property, or is encapsulated within a concrete schema.
SoapHeaderBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to an System.Web.Services.Description.InputBinding or an System.Web.Services.Description.OutputBinding within a Web Service. This class cannot be inherited.
SoapHeaderBinding
Example Syntax:
ToString
Encoding
ToString
Gets or sets a URI representing the encoding style used to encode the SOAP header.
The value of this property should be set only if the value of the System.Web.Services.Description.SoapHeaderBinding.Use property is Encoded.
Handled
MapToProperty
ToString
Description
Message
ToString
Gets or sets a value specifying the name of the System.Web.Services.Description.Message within the Web Service to which the SoapHeaderBinding applies.
The default value of this property is an empty string (“ ”).
Namespace
ToString
Get or sets the URI for encoding of content not specifically defined by the System.Web.Services.Description.SoapHeaderBinding.Encoding property.
This property will return an empty string (“ ”) if the property value has not been set. The value should only be set if the value of the System.Web.Services.Description.SoapHeaderBinding.Use property is Encoded.
Parent
Part
ToString
Description
Gets or sets a value indicating which System.Web.Services.Description.MessagePart within the Web Service the SoapHeaderBinding applies to.
Required
Use
ToString
Description
Specifies whether the header is encoded using encoding rules specified by the System.Web.Services.Description.SoapHeaderBinding.Encoding property, or is encapsulated within a concrete schema.
SoapHeaderFaultBinding class (System.Web.Services.Description)
ToString
Description
Represents an extensibility element added to an System.Web.Services.Description.InputBinding or an System.Web.Services.Description.OutputBinding within the WebService. It specifies the SOAP header types used to transmit error information within the SOAP header. This class cannot be inherited.
SoapHeaderFaultBinding
Example Syntax:
ToString
Encoding
ToString
Gets or sets a URI representing the encoding style used to encode the error message for the SOAP header.
The value of this property should be set only if the value of the System.Web.Services.Description.SoapHeaderFaultBinding.Use property is Encoded.
Handled
Message
ToString
Description
Gets or sets a value specifying the name of the System.Web.Services.Description.Message within the Web Service to which the SoapHeaderFaultBinding applies.
The default value of this property is an empty string (“ ”).
Namespace
ToString
Get or sets the URI for encoding of content not specifically defined by the System.Web.Services.Description.SoapHeaderFaultBinding.Encoding property.
This property will return an empty string (“ ”) if the property value has not been set. The value should only be set if the value of the System.Web.Services.Description.SoapHeaderBinding.Use property is Encoded.
Parent
Part
ToString
Description
Gets or sets a value indicating which System.Web.Services.Description.MessagePart within the Web Service the SoapHeaderFaultBinding applies to.
Required
Use
ToString
Description
Specifies whether the header is encoded using encoding rules specified by the System.Web.Services.Description.SoapHeaderBinding.Encoding property, or is encapsulated within a concrete schema.
SoapOperationBinding class (System.Web.Services.Description)
ToString
Description
Represents an extension added to an System.Web.Services.Description.OperationBinding within a Web Service. Specifies that the message transmission will be in SOAP format. This class cannot be inherited.
SoapOperationBinding
Example Syntax:
ToString
Handled
Parent
Required
SoapAction
ToString
Description
Specifies the URI for the SOAP header.
This property is required for HTTP protocol binding of SOAP.
Style
ToString
One of the System.Web.Services.Description.SoapBindingStyle values. The default is Document.
SoapProtocolImporter class (System.Web.Services.Description)
ToString
Description
SoapProtocolImporter
Example Syntax:
ToString
Abstract Schemas
Binding
ClassName
ClassNames
CodeNamespace
CodeTypeDeclaration
ConcreteSchemas
InputMessage
MethodName
Operation
OperationBinding
OutputMessage
Port
PortType
ProtocolName
ToString
Description
Schemas
Service
ServiceDescriptions
SoapBinding
ToString
Description
SoapExporter
ToString
SoapImporter
ToString
Style
Warnings
XmlExporter
ToString
Description
XmlImporter
ToString
BeginClass
BeginNamespace
EndClass
EndNamespace
GenerateMethod
IsBindingSupported
IsOperationFlowSupported
SoapTransportImporter class (System.Web.Services.Description)
UnsupportedOperationWarning
Description
SoapTransportImporter
Example Syntax:
UnsupportedOperationWarning
ImportContext
UnsupportedOperationWarning
ImportClass
IsSupportedTransport
Types class (System.Web.Services.Description)
ToString
Description
Derived from the System.Web.Services.Description.DocumentableItem class, this class describes data type definitions relevant to exchanged messages. This class cannot be inherited.
This class is a container for datatype definitions for the Web Service. Note especially that this class does NOT represent a collection of System.Type objects, as its name might imply.
Types
Example Syntax:
ToString
Documentation
Extensions
ToString
Description
Gets the collection of ServiceDescriptionFormatExtension elements incuded in the Web Service. This property is read-only.
In the default implementation of the
System.Web.Services.Discovery
Description
The System.Web.Services.Discovery namespace consists of the classes that allows Web Service consumers to locate the available Web Services on a Web server through a process called Web Services Discovery.
ContractReference class (System.Web.Services.Discovery)
Description
Represents a reference in a discovery document to a Service Description.
Web Services discovery involves discovering the available Web Services given an URL. The URL usually points to a discovery document, which typically has a .disco file extension. Within a discovery document are references to information about the existance of Web Services. These references can refer to Service Descriptions, XML Schema Definition language (XSD) schemas or other discovery documents. This class represents a reference to a Service Description.
XML namespace for Service Description references in discovery documents.
Within a discovery document, a reference to a Service Description is contained within a contractRef XML element, which is a part of the XML namespace specified in the System.Web.Services.Discovery.ContractReference.Namespace constant.
Constructors:
ContractReference
Example Syntax:
Initializes a new instance of the System.Web.Services.Discovery.ContractReference class using default values.
Use this constructor to create and initialize a new instance of the System.Web.Services.Discovery.ContractReference class using default values.
ContractReference
Example Syntax:
Initializes a new instance of the System.Web.Services.Discovery.ContractReference class using the supplied reference to a Service Description.
Use this constructor to create and initialize a new instance of the System.Web.Services.Discovery.ContractReference class using the specified reference name. The URL for a Sevice Descritpion. Initializes the System.Web.Services.Discovery.ContractReference.Ref property value.
ContractReference
Example Syntax:
Initializes a new instance of the System.Web.Services.Discovery.ContractReference class using the supplied reference to a Service Description and a Web Service implementing the Service Description.
Use this constructor to create and initialize a new instance of the System.Web.Services.Discovery.ContractReference class using the specified reference name and docref. The URL for a Service Description. Initializes the System.Web.Services.Discovery.ContractReference.Ref property value. The URL for a Web Service implementing the Service Description at href. Initializes the System.Web.Services.Discovery.ContractReference.DocRef property value.
Properties:
ClientProtocol
Contract
Description
Gets a System.Web.Services.Description.ServiceDescription object representing the Service Description.
DefaultFilename
Gets the name of the file to use by default when saving the referenced Service Description.
DocRef
Gets and sets the URL for a Web Service implementing the Service Description referenced in the System.Web.Services.Discovery.ContractReference.Ref property.
Within a discovery document, a reference to a Service Description is contained within a contractRef XML element. The contractRef XML element has two attributes described in the following table.
Ref
Gets or sets the URL to the referenced Service Description.
Within a discovery document, a reference to a Service Description is contained within a contractRef XML element. The contractRef XML element has two attributes described in the following table.
Url
Gets or sets the URL for the referenced Service Description.
For the System.Web.Services.Discovery.ContractReference class, the System.Web.Services.Discovery.ContractReference.Url property returns the value of the System.Web.Services.Discovery.ContractReference.Ref property.
Methods:
ReadDocument
Reads the Service Description from the passed System.IO.Stream and returns the Service Description.
Return Value: A System.Web.Services.Description.ServiceDescription containing the contents of the referenced Service Description. System.IO.Stream containing the Service Description.
Resolve
Resolves whether the the referenced document is valid.
If the MIME type is text/xml and the contents of stream is a Service Description, then the contents of stream are added to the System.Web.Services.Discovery.DiscoveryClientProtocol.References and System.Web.Services.Discovery.DiscoveryClientProtocol.Documents properties of System.Web.Services.Discovery.DiscoveryReference.ClientProtocol. The MIME content type of stream. The System.IO.Stream containing the referenced document.
WriteDocument
Writes the passed-in Service Description into the passed-in System.IO.Stream. The System.Web.Services.Description.ServiceDescription to write into stream. The System.IO.Stream into which the serialized System.Web.Services.Description.ServiceDescription is written.
ContractSearchPattern class (System.Web.Services.Discovery)
WriteDocument
Description
Represents a contract search pattern. This class cannot be inherited.
ContractSearchPattern
Example Syntax:
WriteDocument
Pattern
WriteDocument
Overrides the base implementation to return the literal string, “*.asmx”.
GetDiscoveryReference
Overrides the base implementation to create a System.Web.Services.Discovery.ContractReference object with the specified filename.
Return Value: A System.Web.Services.Discovery.ContractReference object with the specified filename. A string that represents a filename.
DiscoveryClientDocumentCollection class (System.Web.Services.Discovery)
ToString
Description
Represents a collection of documents discovered during Web Services discovery that have been downloaded to the client. This class cannot be inherited.
The System.Web.Services.Discovery.DiscoveryClientProtocol.Documents property of System.Web.Services.Discovery.DiscoveryClientProtocol is of type System.Web.Services.Discovery.DiscoveryClientDocumentCollection.
DiscoveryClientDocumentCollection
Example Syntax:
ToString
Count
Dictionary
InnerHashtable
Item
ToString
Description
Gets or sets a client discovery document object from the System.Web.Services.Discovery.DiscoveryClientDocumentCollection with the specified URL. The URL of the discovery document to get or set from the System.Web.Services.Discovery.DiscoveryClientDocumentCollection.
Keys
ToString
Gets an System.Collections.ICollection object with all of the keys in the System.Web.Services.Discovery.DiscoveryClientDocumentCollection.
Values
ToString
Gets an System.Collections.ICollection object with all of the values in the System.Web.Services.Discovery.DiscoveryClientDocumentCollection.
Add
Adds an object with the specified URL to the System.Web.Services.Discovery.DiscoveryClientDocumentCollection. The URL for the document to add to the System.Web.Services.Discovery.DiscoveryClientDocumentCollection. A discovered document to add to the System.Web.Services.Discovery.DiscoveryClientDocumentCollection.
Contains
Determines if the System.Web.Services.Discovery.DiscoveryClientDocumentCollection contains an object with the specified URL.
Return Value: true if the System.Web.Services.Discovery.DiscoveryClientDocumentCollection contains an object with the specified URL; otherwise, false. The URL for the document to locate within the System.Web.Services.Discovery.DiscoveryClientDocumentCollection.
Remove
Removes an object with the specified URL from the System.Web.Services.Discovery.DiscoveryClientDocumentCollection. The URL for the discovered document to remove from the System.Web.Services.Discovery.DiscoveryClientDocumentCollection.
DiscoveryClientProtocol class (System.Web.Services.Discovery)
ToString
Description
Provides support for programmatically invoking Web Services discovery.
Web Service discovery is the process of locating, or discovering, one or more related documents that describe available Web Services. It is through Web Services discovery that Web Service clients learn about the available Web Services at a given URL and how to use them. Web Services discovery works from the premise that you have already obtained the URL to a discovery document, possibly through a directory service, such as http://uddi.microsoft.com, however, you do not have the details about the Web Services offered. Through Web Services discovery, you can discover the details about the Web Services listed in a System.Web.Services.Discovery.DiscoveryDocument at a specific URL.
DiscoveryClientProtocol
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Discovery.DiscoveryClientProtocol class.
AdditionalInformation
ToString
Gets information in addition to references found in the discovery document.
The System.Web.Services.Discovery.DiscoveryClientProtocol.AdditionalInformation property primarily contains SOAP bindings, represented by the System.Web.Services.Discovery.SoapBinding class, defined in the discovery document.
AllowAutoRedirect
ClientCertificates
ConnectionGroupName
Container
CookieContainer
Credentials
DesignMode
Documents
ToString
Description
Gets a collection of discovery documents.
The System.Web.Services.Discovery.DiscoveryClientProtocol.Documents collection is populated during invocations to the System.Web.Services.Discovery.DiscoveryClientProtocol.Discover(System.String), System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoverAny(System.String), System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll and System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel methods. During invocations to the System.Web.Services.Discovery.DiscoveryClientProtocol.Discover(System.String) and System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoverAny(System.String) methods, if the supplied URL is a valid discovery document, that document is added to the System.Web.Services.Discovery.DiscoveryClientProtocol.Documents collection. During invocations to the System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll and System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel methods, valid discovery document references in the System.Web.Services.Discovery.DiscoveryClientProtocol.References collection are added to the System.Web.Services.Discovery.DiscoveryClientProtocol.Documents collection.
Errors
ToString
Gets a collection of exceptions that occurred during invocation of method from this class.
The System.Web.Services.Discovery.DiscoveryClientProtocol.Errors collection is populated with exceptions that occurred during invocations to the System.Web.Services.Discovery.DiscoveryClientProtocol.Discover(System.String), System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoverAny(System.String), System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll, and System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel methods. The System.Web.Services.Discovery.DiscoveryExceptionDictionary is cleared on invocation of these methods.
Events
PreAuthenticate
Proxy
References
ToString
Description
A collection of references founds in resolved discovery documents.
The System.Web.Services.Discovery.DiscoveryClientProtocol.References collection is populated during invocations to the System.Web.Services.Discovery.DiscoveryClientProtocol.Discover(System.String), System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoverAny(System.String), System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll and System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel methods. During invocations to the System.Web.Services.Discovery.DiscoveryClientProtocol.Discover(System.String) and System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoverAny(System.String) methods, if the supplied URL is a valid discovery document, that document is added to the System.Web.Services.Discovery.DiscoveryClientProtocol.References collection together with references found in the discovery document. References added during invocations to the System.Web.Services.Discovery.DiscoveryClientProtocol.Discover(System.String) and System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoverAny(System.String) methods are not necessarily valid discovery documents. During invocations to System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll and System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel references within the System.Web.Services.Discovery.DiscoveryClientProtocol.References collection are verified as being valid discovery documents. If they are valid and contain references, they are also added to the System.Web.Services.Discovery.DiscoveryClientProtocol.References collection.
RequestEncoding
Site
Timeout
Url
UserAgent
Discover
Discovers the supplied URL to determine if it is a discovery document.
Return Value: A System.Web.Services.Discovery.DiscoveryDocument containing the results of Web Services discovery at the supplied URL.
The System.Web.Services.Discovery.DiscoveryClientProtocol.Discover(System.String) method expects that the supplied URL is a discovery document. If the URL refers to a Service Description or an XML schema an exception is thrown. To discover an XML schema or a Service Description invoke the System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoverAny(System.String) method. The URL where Web Services discovery begins.
DiscoverAny
Discovers the supplied URL to determine if it is a discovery document, Service Description or an XML Schema Definition (XSD) schema.
Return Value: A System.Web.Services.Discovery.DiscoveryDocument containing the results of Web Services discovery at the supplied URL. If the url parameter refers to a Service Description or an XSD Schema, a System.Web.Services.Discovery.DiscoveryDocument is created in memory for it.
The System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoverAny(System.String) method discovers whether the supplied URL is a discovery document, Service Description or XSD schema. If it is known that the URL only refers to a discovery document, the System.Web.Services.Discovery.DiscoveryClientProtocol.Discover(System.String) method might be invoked. The URL where Web Services discovery begins.
Download
Downloads the discovery document at the supplied URL into a System.IO.Stream object.
Return Value: A System.IO.Stream containing the document at the supplied URL. The URL of the discovery document to download.
Download
Downloads the discovery document at the supplied URL into a System.IO.Stream object, setting the conten(Type parameter to the MIME encoding of the discovery document.
Return Value: A System.IO.Stream containing the document at the supplied URL. The URL of the discovery document to download. The MIME encoding of the downloaded discovery document.
ReadAll
Reads in a file containing a map of saved discovery documents populating the System.Web.Services.Discovery.DiscoveryClientProtocol.Documents and System.Web.Services.Discovery.DiscoveryClientProtocol.References properties, with discovery documents, XML Schema Definition (XSD) schemas, and Service Descriptions referenced in the file.
Return Value: A
System.Web.Services.Discovery.DiscoveryClientResultCollection containing the results found in the file with the map of saved discovery documents. The file format is a System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoveryClientRes ultsFile class serialized into XML; however, one would typically create the file using only the System.Web.Services.Discovery.DiscoveryClientProtocol.WriteAll(System.String,System.String) method or Disco.exe.
A file containing a map of saved discovery documents can be created by the System.Web.Services.Discovery.DiscoveryClientProtocol.WriteAll(System.String,System.String) method or Disco.exe. Name of file to read in, containing the map of saved discovery documents.
ResolveAll
Resolves all references to discovery documents, XML Schema Definition (XSD) schemas, and Service Descriptions in the System.Web.Services.Discovery.DiscoveryClientProtocol.References property, as well as references found in referring discovery documents.
System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll resolves all valid references it finds and places them in the System.Web.Services.Discovery.DiscoveryClientProtocol.Documents property. Both System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll and System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel download and verify XSD schemas and Service Descriptions in the System.Web.Services.Discovery.DiscoveryClientProtocol.References property. However, the two methods differ in how they handle discovery documents.
ResolveOneLevel
Resolves all references to discovery documents, XML Schema Definition (XSD) schemas and Service Descriptions in System.Web.Services.Discovery.DiscoveryClientProtocol.References, as well as references found in those discovery documents.
System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel resolves all valid references it finds and places them in the System.Web.Services.Discovery.DiscoveryClientProtocol.Documents property. Both System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll and System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel download and verify XSD schemas and Service Descriptions in the System.Web.Services.Discovery.DiscoveryClientProtocol.References property. However, the two methods differ in how they handle discovery documents.
WriteAll
Writes all discovery documents, XML Schema Definition (XSD) schemas, and Service Descriptions in the System.Web.Services.Discovery.DiscoveryClientProtocol.Documents property to the supplied directory and creates a file in that directory.
Return Value: A System.Web.Services.Discovery.DiscoveryClientResultCollection containing the results of all files saved.
The file created with the name of the topLevelFilename parameter in the directory specified by the directory parameter contains a map of saved discovery documents, XML Schema Definition (XSD) schemas and Service Descriptions. This file can be read in using the System.Web.Services.Discovery.DiscoveryClientProtocol.ReadAll(System.String) method to populate the System.Web.Services.Discovery.DiscoveryClientProtocol.References and System.Web.Services.Discovery.DiscoveryClientProtocol.Documents properties. The format of the file is XML containing an serialized version of the System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoveryClientResultsfile class. The directory in which to save all documents currently in the System.Web.Services.Discovery.DiscoveryClientProtocol.Documents property. The name of the file to create or overwrite containing a map of all documents saved.
DiscoveryClientReferenceCollection class (System.Web.Services.Discovery)
WriteAll
Description
Represents a collection of System.Web.Services.Discovery.DiscoveryReference objects. This class cannot be inherited.
The System.Web.Services.Discovery.DiscoveryClientProtocol.References property of System.Web.Services.Discovery.DiscoveryClientProtocol is of type System.Web.Services.Discovery.DiscoveryClientReferenceCollection.
DiscoveryClientReferenceCollection
Example Syntax:
WriteAll
Count
Dictionary
InnerHashtable
Item
WriteAll
Description
Gets or sets a System.Web.Services.Discovery.DiscoveryReference object from the System.Web.Services.Discovery.DiscoveryClientReferenceCollection with the specified URL. The URL for the DiscoveryReference to get or set from the System.Web.Services.Discovery.DiscoveryClientReferenceCollection.
Keys
WriteAll
Gets an System.Collections.ICollection object with all of the keys in the System.Web.Services.Discovery.DiscoveryClientReferenceCollection.
Values
WriteAll
Gets an System.Collections.ICollection object with all of the values in the System.Web.Services.Discovery.DiscoveryClientReferenceCollection.
Add
Adds a System.Web.Services.Discovery.DiscoveryReference to the System.Web.Services.Discovery.DiscoveryClientReferenceCollection. The System.Web.Services.Discovery.DiscoveryReference to add to the System.Web.Services.Discovery.DiscoveryClientReferenceCollection.
Add
Adds a System.Web.Services.Discovery.DiscoveryReference with the specified URL and value to the System.Web.Services.Discovery.DiscoveryClientReferenceCollection. The URL for the reference to add to the System.Web.Services.Discovery.DiscoveryClientReferenceCollection. The DiscoveryReference to add to the System.Web.Services.Discovery.DiscoveryClientReferenceCollection.
Contains
Determines if the System.Web.Services.Discovery.DiscoveryClientReferenceCollection contains a System.Web.Services.Discovery.DiscoveryReference with the specified URL.
Return Value: true if the System.Web.Services.Discovery.DiscoveryClientReferenceCollection contains a System.Web.Services.Discovery.DiscoveryReference with the specified URL; otherwise, false. The URL for the System.Web.Services.Discovery.DiscoveryReference to locate within the System.Web.Services.Discovery.DiscoveryClientReferenceCollection.
Remove
Removes a System.Web.Services.Discovery.DiscoveryReference with the specified URL from the System.Web.Services.Discovery.DiscoveryClientReferenceCollection. A string that represents the URL for the object to remove from the System.Web.Services.Discovery.DiscoveryClientReferenceCollection.
DiscoveryClientResult class (System.Web.Services.Discovery)
ToString
Description
Represents the details of a discovery reference without the actual contents of the referenced document. This class cannot be inherited.
Using the System.Web.Services.Discovery.DiscoveryClientProtocol.WriteAll(System.String,System.String) method of System.Web.Services.Discovery.DiscoveryClientProtocol, all valid referenced documents and a file containing a map of all save documents can be written to disk. The file containing a map of all saved documents contains the details of each document as summarized by the properties of System.Web.Services.Discovery.DiscoveryClientResult.
DiscoveryClientResult
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Discovery.DiscoveryClientResult class.
DiscoveryClientResult
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Discovery.DiscoveryClientResult class and sets the System.Web.Services.Discovery.DiscoveryClientResult.ReferenceTypeName property to referenceType, the System.Web.Services.Discovery.DiscoveryClientResult.Url property to url and the System.Web.Services.Discovery.DiscoveryClientResult.Filename property to filename. Name of the type for a reference in the discovery document. Sets the System.Web.Services.Discovery.DiscoveryClientResult.ReferenceTypeName property. URL for the reference. Sets the System.Web.Services.Discovery.DiscoveryClientResult.Urt property. Name of the file in which the reference was saved. Sets the System.Web.Services.Discovery.DiscoveryClientResult.Filename property.
Filename
ToString
Gets or sets the name of the file in which the reference is saved.
The name of the file is the name of the file saved on the local machine based on the contents of the file. For instance, if the referenced file is a discovery document, the saved file will have a .disco extension on a Windows operating system.
ReferenceTypeName
ToString
Name of the type for a reference in the discovery document.
A reference within a discovery document can contain references to Service Descriptions, XSD schemas, or other discovery documents. Therefore, System.Web.Services.Discovery.DiscoveryClientResult.ReferenceTypeName can have the following values: System.Web.Services.Description.ServiceDescription, System.Xml.Schema.XmlSchema, and System.Web.Services.Discovery.DiscoveryDocument.
Url
ToString
Gets or sets the URL for the reference.
The URL can refer to a discovery document, XML Schema Definition (XSD) schema, or a Service Description.
DiscoveryClientResultCollection class (System.Web.Services.Discovery)
ToString
Description
Contains a collection of System.Web.Services.Discovery.DiscoveryClientResult objects. This class cannot be inherited.
DiscoveryClientResultCollection
Example Syntax:
ToString
Count
InnerList
Item
ToString
Description
Gets or sets the System.Web.Services.Discovery.DiscoveryClientResult at position i of the System.Web.Services.Discovery.DiscoveryClientResultCollection.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[index]. The zero-based index of the System.Web.Services.Discovery.DiscoveryClientResult to get or set.
List
Add
Adds a System.Web.Services.Discovery.DiscoveryClientResult to the System.Web.Services.Discovery.DiscoveryClientResultCollection.
Return Value: The position into which the System.Web.Services.Discovery.DiscoveryClientResult was inserted. The System.Web.Services.Discovery.DiscoveryClientResult to add to the System.Web.Services.Discovery.DiscoveryClientResultCollection.
Contains
Determines whether the System.Web.Services.Discovery.DiscoveryClientResultCollection contains a specific System.Web.Services.Discovery.DiscoveryClientResult.
Return Value: true if the System.Web.Services.Discovery.DiscoveryClientResult is found in the System.Web.Services.Discovery.DiscoveryClientResultCollection; otherwise, false. The System.Web.Services.Discovery.DiscoveryClientResult to locate in the System.Web.Services.Discovery.DiscoveryClientResultCollection.
Remove
Removes the first occurrence of a specific System.Web.Services.Discovery.DiscoveryClientResult from the System.Web.Services.Discovery.DiscoveryClientResultCollection
The System.Web.Services.Discovery.DiscoveryClientResult elements that follow the removed System.Web.Services.Discovery.DiscoveryClientResult move up to occupy the vacated spot. The System.Web.Services.Discovery.DiscoveryClientResult to remove from the System.Web.Services.Discovery.DiscoveryClientResultCollection.
DiscoveryClientProtocol.DiscoveryClientResultsFile class (System.Web.Services.Discovery)
ToString
Description
Represents the root element of an XML document containing the results of all files written when the System.Web.Services.Discovery.DiscoveryClientProtocol.WriteAll(System.String,System.String) method is invoked.
When you invoke the System.Web.Services.Discovery.DiscoveryClientProtocol.WriteAll(System.String,System.String) method, all resolved discovery documents and a file containing a map of all those files are saved to a directory. The map file is described in XML with the root element being System.Web.Services.Discovery.DiscoveryClientProtocol.DiscoveryClientResultsfile; this class is passed to the System.Xml.Serialization.XmlSerializer class to serialize the results.
DiscoveryClientProtocol.DiscoveryClientResultsFile
Example Syntax:
ToString
Results
ToString
Gets a collection of System.Web.Services.Discovery.DiscoveryClientResult objects.
DiscoveryDocument class (System.Web.Services.Discovery)
ToString
Description
Represents a discovery document. This class cannot be inherited.
Web Services discovery involves discovering the available Web Services given an URL. The URL typically points to a discovery document, which usually has a .disco file extension. The discovery document, which is an XML document, contains references to information about the existance of Web Services, such as a Service Description, XML Schema Definition language (XSD) schema, or another discovery document. This class represents the contents of the discovery document; where the System.Web.Services.Discovery.DiscoveryDocument.References property contains a list of the references contained within the discovery document.
ToString
Namespace of the discovery XML element of a discovery document.
A discovery document contains references to documents describing Web Services. These references are XML elements contained within a discovery XML element. That discovery XML element is a member of the XML namespace specified by the System.Web.Services.Discovery.DiscoveryDocument.Namespace constant.
DiscoveryDocument
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Discovery.DiscoveryDocument class.
References
ToString
A list of references contained within the discovery document.
A discovery document contains references to information about the existence of Web Services. These references can refer to Service Descriptions, XSD schemas, or other discovery documents. The System.Web.Services.Discovery.DiscoveryDocument.References property contains a list of those references.
CanRead
Returns a value indicating whether the passed System.Xml.XmlReader can be deserialized into a System.Web.Services.Discovery.DiscoveryDocument
Return Value: true if System.Xml.XmlReader can be deserialized into a System.Web.Services.Discovery.DiscoveryDocument; otherwise, false. The System.Xml.XmlReader to determine whether it can be deserialized into a System.Web.Services.Discovery.DiscoveryDocument.
Read
Reads and returns a System.Web.Services.Discovery.DiscoveryDocument from the passed System.IO.Stream.
Return Value: A System.Web.Services.Discovery.DiscoveryDocument containing the contents of a discovery document from the passed System.IO.Stream. The System.IO.Stream from which to read the System.Web.Services.Discovery.DiscoveryDocument.
Read
Reads and returns a System.Web.Services.Discovery.DiscoveryDocument from the passed System.IO.TextReader.
Return Value: A System.Web.Services.Discovery.DiscoveryDocument containing the contents of a discovery document from the passed System.IO.TextReader. The System.IO.TextReader from which to read the System.Web.Services.Discovery.DiscoveryDocument.
Read
Reads and returns a System.Web.Services.Discovery.DiscoveryDocument from the passed System.Xml.XmlReader.
Return Value: A System.Web.Services.Discovery.DiscoveryDocument containing the contents of a discovery document from the passed System.Xml.XmlReader. The System.Xml.XmlReader from which to read the System.Web.Services.Discovery.DiscoveryDocument.
Write
Writes this System.Web.Services.Discovery.DiscoveryDocument into the passed System.IO.Stream. The System.IO.Stream into which this System.Web.Services.Discovery.DiscoveryDocument is written.
Write
Writes this System.Web.Services.Discovery.DiscoveryDocument into the passed System.IO.TextWriter. The System.IO.TextWriter into which this System.Web.Services.Discovery.DiscoveryDocument is written.
Write
Writes this System.Web.Services.Discovery.DiscoveryDocument into the passed System.Xml.XmlWriter. The System.Xml.XmlWriter into which this System.Web.Services.Discovery.DiscoveryDocument is written.
DiscoveryDocumentLinksPattern class (System.Web.Services.Discovery)
Write
Description
DiscoveryDocumentLinksPattern
Example Syntax:
Write
Pattern
Write
GetDiscoveryReference
DiscoveryDocumentReference class (System.Web.Services.Discovery)
ToString
Description
Represents a reference to a discovery document. This class cannot be inherited.
Web Services discovery involves discovering the available Web Services given an URL. The URL typically points to a discovery document, which usually has a .disco file extension. The discovery document contains references to information about the existance of Web Services, such as Service Descriptions, XML Schema Definition language (XSD) schemas, or other discovery documents. This class represents a reference to a discovery document.
DiscoveryDocumentReference
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Discovery.DiscoveryDocumentReference class.
DiscoveryDocumentReference
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Discovery.DiscoveryDocumentReference class, setting the System.Web.Services.Discovery.DiscoveryDocumentReference.Ref property to href. Reference to a discovery document.
ClientProtocol
DefaultFilename
ToString
Description
Gets the name of the default file to use when saving the referenced discovery document.
Document
ToString
Gets the contents of the referenced discovery document as a System.Web.Services.Discovery.DiscoveryDocument object.
If the discovery document has not been downloaded and added to the System.Web.Services.Discovery.DiscoveryClientProtocol.Documents property of System.Web.Services.Discovery.DiscoveryReference.ClientProtocol, an attempt to download and resolve the document is made.
Ref
ToString
Gets or sets the reference to a discovery document.
For most references, the System.Web.Services.Discovery.DiscoveryDocumentReference.Ref property is a URL, such as http://www.contoso.com/MyWebService.disco.
Url
ToString
Gets or sets the URL of the referenced discovery document.
Returns the value of the System.Web.Services.Discovery.DiscoveryDocumentReference.Ref property.
ReadDocument
Reads and returns the discovery document from the passed System.IO.Stream.
Return Value: A System.Web.Services.Discovery.DiscoveryDocument containing the contents of the referenced discovery document. System.IO.Stream containing the discovery document.
Resolve
Resolves whether the referenced document is valid.
If the MIME type is text/xml and the contents of stream is a discovery document, then the contents of stream are added to the System.Web.Services.Discovery.DiscoveryClientProtocol.References and System.Web.Services.Discovery.DiscoveryClientProtocol.Documents properties of System.Web.Services.Discovery.DiscoveryReference.ClientProtocol. The MIME type of stream. The System.IO.Stream containing the referenced document.
ResolveAll
Verifies that all referenced documents within the discovery document are valid.
Unless you specifically need to resolve the individual references of a System.Web.Services.Discovery.DiscoveryDocumentReference object, you should invoke the System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll or System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel methods of System.Web.Services.Discovery.DiscoveryClientProtocol.
WriteDocument
Writes the passed System.Web.Services.Discovery.DiscoveryDocument into the passed System.IO.Stream. The System.Web.Services.Discovery.DiscoveryDocument to write into stream. The System.IO.Stream into which the serialized discovery document is written.
DiscoveryDocumentSearchPattern class (System.Web.Services.Discovery)
WriteDocument
Description
DiscoveryDocumentSearchPattern
Example Syntax:
WriteDocument
Pattern
WriteDocument
GetDiscoveryReference
DiscoveryExceptionDictionary class (System.Web.Services.Discovery)
ToString
Description
Collects exceptions that occurred during Web Services discovery. This class cannot be inherited.
The System.Web.Services.Discovery.DiscoveryClientProtocol.Errors property of System.Web.Services.Discovery.DiscoveryClientProtocol is of type System.Web.Services.Discovery.DiscoveryExceptionDictionary.
DiscoveryExceptionDictionary
Example Syntax:
ToString
Count
Dictionary
InnerHashtable
Item
ToString
Description
Gets or sets the System.Exception that occurred while discovering the specified URL from the System.Web.Services.Discovery.DiscoveryExceptionDictionary. The URL of the discovery document that caused an exception to be thrown during Web Services discovery.
Keys
ToString
Gets a System.Collections.ICollection object with all of the keys in the System.Web.Services.Discovery.DiscoveryExceptionDictionary.
Values
ToString
Gets a System.Collections.ICollection object containing all of the values in the System.Web.Services.Discovery.DiscoveryExceptionDictionary.
Add
Adds an System.Exception with a key of url to the System.Web.Services.Discovery.DiscoveryExceptionDictionary. The URL that caused an exception during Web Services discovery. The System.Exception that occurred during Web Services discovery.
Contains
Determines whether the System.Web.Services.Discovery.DiscoveryExceptionDictionary contains an System.Exception with the specified URL.
Return Value: true if the System.Web.Services.Discovery.DiscoveryExceptionDictionary contains an System.Exception with the specified URL; otherwise, false. The URL of the System.Exception to locate within the System.Web.Services.Discovery.DiscoveryExceptionDictionary.
Remove
Removes an System.Exception with the specified URL from the System.Web.Services.Discovery.DiscoveryExceptionDictionary. The URL of the System.Exception to remove from the System.Web.Services.Discovery.DiscoveryExceptionDictionary.
DiscoveryReference class (System.Web.Services.Discovery)
ToString
Description
The base class for discoverable references using Web Services discovery.
System.Web.Services.Discovery.ContractReference, System.Web.Services.Discovery.SchemaReference, and System.Web.Services.Discovery.DiscoveryDocumentReference all inherit from System.Web.Services.Discovery.DiscoveryReference, and represent the three types of documents disoverable through Web Services discovery: Service Descriptions, XML Schema Definition (XSD) schemas, and discovery documents, respectively.
DiscoveryReference
Example Syntax:
ToString
ClientProtocol
ToString
Gets or sets the instance of System.Web.Services.Discovery.DiscoveryClientProtocol used in a discovery process.
DefaultFilename
ToString
Gets the name of the default file to use when saving the referenced discovery document, XSD schema, or Service Description.
Url
ToString
Gets or sets the URL of the referenced document.
FilenameFromUrl
Returns a file name based on the passed URL.
Return Value: Name of the file based on the passed URL. The URL on which the name of the file is based.
ReadDocument
Reads the passed System.IO.Stream and returns an instance of the class representing the type of referenced document.
Return Value: An System.Object with an underlying type matching the type of referenced document.
The return value is always an System.Object. However, the underlying type varies, depending on the type of document referenced. For instance, a System.IO.Stream passed into System.Web.Services.Discovery.SchemaReference.ReadDocument(System.IO.Stream) returns an instance of System.Xml.Schema.XmlSchema. System.IO.Streamcontaining the reference document.
Resolve
Downloads the referenced document at System.Web.Services.Discovery.DiscoveryReference.Url to resolve whether the referenced document is valid.
Downloads the referenced document and then invokes the overloaded System.Web.Services.Discovery.DiscoveryReference.Resolve member that takes a contentType and a System.IO.Stream. If the MIME type and the contents of stream match those expected by the reference type, then the contents of stream are added to the System.Web.Services.Discovery.DiscoveryClientProtocol.References and System.Web.Services.Discovery.DiscoveryClientProtocol.Documents properties of System.Web.Services.Discovery.DiscoveryReference.ClientProtocol.
Resolve
Resolves whether the referenced document is valid.
If the MIME type and the contents of stream match those expected by the reference type, then the contents of stream are added to the System.Web.Services.Discovery.DiscoveryClientProtocol.References and System.Web.Services.Discovery.DiscoveryClientProtocol.Documents properties of System.Web.Services.Discovery.DiscoveryReference.ClientProtocol. The MIME type of stream. The System.IO.Stream containing the referenced document.
WriteDocument
When overridden in a derived class, writes the document into a System.IO.Stream. The document to write into a System.IO.Stream. The System.IO.Stream into which the document is written.
DiscoveryReferenceCollection class (System.Web.Services.Discovery)
WriteDocument
Description
A collection of discovery references. This class cannot be inherited.
DiscoveryReferenceCollection
Example Syntax:
WriteDocument
Count
InnerList
Item
WriteDocument
Description
Gets or sets the System.Web.Services.Discovery.DiscoveryReference at the specified index. The zero-based index of the System.Web.Services.Discovery.DiscoveryReference to get or set.
List
Add
Adds a System.Web.Services.Discovery.DiscoveryReference to the System.Web.Services.Discovery.DiscoveryReferenceCollection
Return Value: The position into which the System.Web.Services.Discovery.DiscoveryReference was inserted into the System.Web.Services.Discovery.DiscoveryReferenceCollection. The System.Web.Services.Discovery.DiscoveryReference to add to the System.Web.Services.Discovery.DiscoveryReferenceCollection.
Contains
Determines whether the System.Web.Services.Discovery.DiscoveryReferenceCollection contains a specific System.Web.Services.Discovery.DiscoveryReference.
Return Value: true if the System.Web.Services.Discovery.DiscoveryReferenceCollection contains the System.Web.Services.Discovery.DiscoveryReference; otherwise, false. The System.Web.Services.Discovery.DiscoveryReference to locate within the System.Web.Services.Discovery.DiscoveryReferenceCollection.
Remove
Removes a System.Web.Services.Discovery.DiscoveryReference from the System.Web.Services.Discovery.DiscoveryReferenceCollection. The System.Web.Services.Discovery.DiscoveryReference to remove from the System.Web.Services.Discovery.DiscoveryReferenceCollection.
DiscoveryRequestHandler class (System.Web.Services.Discovery)
ToString
Description
DiscoveryRequestHandler
Example Syntax:
ToString
IsReusable
ToString
ProcessRequest
DiscoverySearchPattern class (System.Web.Services.Discovery)
ToString
Description
DiscoverySearchPattern
Example Syntax:
ToString
Pattern
ToString
GetDiscoveryReference
DynamicDiscoveryDocument class (System.Web.Services.Discovery)
ToString
Description
This represents a discovery file.
ToString
DynamicDiscoveryDocument
Example Syntax:
ToString
Default constructor.
ExcludePaths
ToString
Load
Read an instance of WebMethodsFile from a stream.
Write
Write this instance to a stream.
ExcludePathInfo class (System.Web.Services.Discovery)
Write
Description
ExcludePathInfo
Example Syntax:
Write
ExcludePathInfo
Example Syntax:
Write
Path
Write
SchemaReference class (System.Web.Services.Discovery)
ToString
Description
Represents a reference in a discovery document to an XML Schema Definition language (XSD) schema. This class cannot be inherited.
Web Services discovery involves discovering the available Web Services given an URL. A The URL typically points to a discovery document, that usually has a .disco file extension. The discovery document contains references to information about the existance of Web Services. These references can refer to Service Descriptions, XSD schemas, or other discovery documents. This class represents a reference to an XSD schema.
ToString
XML namespace for XSD schema references in discovery documents.
Within a discovery document, a reference to an XSD schema is contained within a schemaRef XML element, which is a part of the XML namespace specified in the System.Web.Services.Discovery.SchemaReference.Namespace constant.
SchemaReference
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Discovery.SchemaReference class using default values.
SchemaReference
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Discovery.SchemaReference class using the supplied URL as the XSD schema reference. The URL for the XSD schema. Initializes the System.Web.Services.Discovery.SchemaReference.Ref property.
ClientProtocol
DefaultFilename
ToString
Description
Gets the name of the default file to use when saving the referenced XSD schema.
Ref
ToString
Gets or sets the URL to the referenced XSD schema.
In a discovery document, a reference to an XSD schema is contained within a schemaRef XML element. The schemaRef XML element has a ref attribute, which is the URL for the referenced XSD schema. The System.Web.Services.Discovery.ContractReference.Ref property represents the value of the ref attribute.
Schema
ToString
Gets an System.Xml.Schema.XmlSchema object representing the XSD schema.
If the XSD schema has not been downloaded and added to the System.Web.Services.Discovery.DiscoveryClientProtocol.Documents property of System.Web.Services.Discovery.DiscoveryReference.ClientProtocol, an attempt to download and resolve the document is made.
TargetNamespace
ToString
Gets or sets the targetNamespace XML attribute of the XSD schema.
Url
ToString
Gets or sets the URL for the schema reference.
For the System.Web.Services.Discovery.SchemaReference class, the System.Web.Services.Discovery.SchemaReference.Url property returns the value of the System.Web.Services.Discovery.SchemaReference.Ref property.
ReadDocument
Reads and returns the XSD schema from the passed System.IO.Stream.
Return Value: An System.Xml.Schema.XmlSchema containing the contents of the referenced XSD schema. System.IO.Stream containing the XSD schema.
Resolve
Resolves whether the the referenced document is valid.
If the MIME type is text/xml and the contents of stream are an XSD schema, then the contents of stream are added to the System.Web.Services.Discovery.DiscoveryClientProtocol.References and System.Web.Services.Discovery.DiscoveryClientProtocol.Documents properties of System.Web.Services.Discovery.DiscoveryReference.ClientProtocol. The MIME content type of stream. The System.IO.Stream containing the referenced document.
WriteDocument
Writes the passed XSD schema into the passed System.IO.Stream. The System.Xml.Schema.XmlSchema to write into stream. The System.IO.Stream into which the serialized XSD schema is written.
SoapBinding class (System.Web.Services.Discovery)
WriteDocument
Description
Represents a SOAP binding in a discovery document. This class cannot be inherited.
A SOAP binding is similar to an interface for Web Services and useful for versioning and when a developer is looking for a Web Service implementing a specific SOAP binding. For instance, a discovery document may contain optional information about SOAP Bindings, which specify the SOAP bindings implemented by referenced Web Servcies. SOAP bindings are specified within a discovery document by adding a soap XML element with an XML namespace equal to the System.Web.Services.Discovery.SoapBinding.Namespace constant. The System.Web.Services.Discovery.SoapBinding.Address property specifies the URL to the Web Service and the System.Web.Services.Discovery.SoapBinding.Binding property specifies the SOAP binding implemented by that Web Service.
WriteDocument
The XML namespace of the element that specifies a SOAP binding within a discovery document.
SOAP bindings within a discovery document reside within a soap XML element that is a member of the XML namespace specifed by the System.Web.Services.Discovery.SoapBinding.Namespace constant.
SoapBinding
Example Syntax:
WriteDocument
Address
WriteDocument
Gets or sets the URL of the Web Service implementing the SOAP binding.
Binding
WriteDocument
Gets or sets the XML qualified name of the SOAP binding implemented by the Web Service.
XmlSchemaSearchPattern class (System.Web.Services.Discovery)
ToString
Description
XmlSchemaSearchPattern
Example Syntax:
ToString
Pattern
ToString
The System.Web.Services.Protocols namespace consists of the classes that define the protocols used to transmit data across the wire during the communication between ASP.NET Web Service clients and Web Services.
AnyReturnReader class (System.Web.Services.Protocols)
Description
Constructors:
AnyReturnReader
Example Syntax:
Methods:
GetInitializer
Initialize
Read
HtmlFormParameterReader class (System.Web.Services.Protocols)
ToString
Description
HtmlFormParameterReader
Example Syntax:
ToString
Read
HtmlFormParameterWriter class (System.Web.Services.Protocols)
ToString
Description
HtmlFormParameterWriter
Example Syntax:
ToString
Properties:
RequestEncoding
UsesWriteRequest
ToString
Description
InitializeRequest
WriteRequest
HttpGetClientProtocol class (System.Web.Services.Protocols)
WriteRequest
Description
Specifies the class for ASP.NET Web Service client proxies that use the HTTP-GET protocol.
ASP.NET incorporates two distinct Web Services functionalities: Building ASP.NET Web Services and Building Web Services clients. If you are building a Web Service client using ASP.NET, then a proxy class deriving indirectly or directly from System.Web.Services.Protocols.WebClientProtocol needs to be created for the Web Service you want to call. When the Web Service client calls the Web Service using HTTP, derive the proxy class from System.Web.Services.Protocols.HttpSimpleClientProtocol, which in turn derives from System.Web.Services.Protocols.WebClientProtocol.
HttpGetClientProtocol
Example Syntax:
WriteRequest
Initializes a new instance of the System.Web.Services.Protocols.HttpGetClientProtocol class.
AllowAutoRedirect
ClientCertificates
ConnectionGroupName
Container
CookieContainer
Credentials
DesignMode
Events
PreAuthenticate
Proxy
RequestEncoding
Site
Timeout
Url
UserAgent
GetWebRequest
Creates a System.Net.WebRequest instance for the specified URI.
Return Value: The System.Net.WebRequest instance.
This method overrides the base version of System.Web.Services.Protocols.WebClientProtocol.GetWebRequest(System.Uri) to specify that the HTTP request to the Web Service is made using HTTP-GET. By overriding this method, additional customizations can be made to the System.Net.WebRequest object before the Web Service request is made. For example you could add a custom header to the request. The System.Uri to use when creating theSystem.Net.WebRequest.
HttpMethodAttribute class (System.Web.Services.Protocols)
ToString
Description
Applying this attribute to a Web Service client using HTTP-GET or HTTP-POST, sets the types that serialize the parameters sent to a Web Service method and read the response from the Web Service method. This class cannot be inherited.
If a Web Service client invokes a Web Service method using HTTP-GET, System.Web.Services.Protocols.HttpMethodAttribute.ReturnFormatter must be set to XmlReturnReader and System.Web.Services.Protocols.HttpMethodAttribute.ParameterFormatter set to UrlParameterWriter. Web Service clients invoking a Web Service using HTTP-POST must set System.Web.Services.Protocols.HttpMethodAttribute.ReturnFormatter to XmlReturnReader and System.Web.Services.Protocols.HttpMethodAttribute.ParameterFormatter to HtmlFormParameterWriter.
HttpMethodAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.HttpMethodAttribute class.
HttpMethodAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.HttpMethodAttribute. Initializes the System.Web.Services.Protocols.HttpMethodAttribute.ReturnFormatter property to a System.Type that deserializes the response from a Web Service method. Initializes the System.Web.Services.Protocols.HttpMethodAttribute.ParameterFormatter property to a System.Type that serializes parameters sent from a Web Service client to a Web Service method.
ParameterFormatter
ToString
Gets or sets a System.Type that serializes parameters sent from a Web Service client to the Web Service method.
If the Web Service client is invoking a Web Service method using HTTP-GET or HTTP-POST, System.Web.Services.Protocols.HttpMethodAttribute.ParameterFormatter must be XMLReturnReader.
ReturnFormatter
ToString
Gets or sets a System.Type that deserializes the response from a Web Service method.
If the Web Service client is invoking a Web Service method using HTTP-GET, System.Web.Services.Protocols.HttpMethodAttribute.ReturnFormatter must be UrlParameterWriter, whereas a client using HTTP-POST must set System.Web.Services.Protocols.HttpMethodAttribute.ReturnFormatter to HtmlFormParameterWriter.
TypeId
HttpPostClientProtocol class (System.Web.Services.Protocols)
ToString
Description
Specifies the class for ASP.NET Web Service client proxies that use the HTTP-POST protocol.
ASP.NET incorporates two distinct Web Services functionalities: Building ASP.NET Web Services and Building Web Services clients. If you are building a Web Service client using ASP.NET, then a proxy class deriving indirectly or directly from System.Web.Services.Protocols.WebClientProtocol needs to be created for the Web Service you want to call. When the Web Service client is calling using HTTP, the proxy class should derive from System.Web.Services.Protocols.HttpSimpleClientProtocol, which derives from System.Web.Services.Protocols.WebClientProtocol.
HttpPostClientProtocol
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.HttpPostClientProtocol class.
AllowAutoRedirect
ClientCertificates
ConnectionGroupName
Container
CookieContainer
Credentials
DesignMode
Events
PreAuthenticate
Proxy
RequestEncoding
Site
Timeout
Url
UserAgent
GetWebRequest
Creates a System.Net.WebRequest instance for the specified URI.
Return Value: The System.Net.WebRequest instance.
This method overrides the base version of System.Web.Services.Protocols.WebClientProtocol.GetWebRequest(System. Uri) to specify that the HTTP request to the Web Service is made using HTTP-POST. By overriding this method, you can customize the System.Net.WebRequest object before the Web Service request is made. For example, you can add a custom header to the request. The System.Uri to use when creating the System.Net.WebRequest.
HttpSimpleClientProtocol class (System.Web.Services.Protocols)
ToString
Description
The base class for communicating with an Web Service using HTTP-GET and HTTP-POST.
Specifies most of the implementation for communicating with an Web Service over HTTP.
HttpSimpleClientProtocol
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.HttpSimpleClientProtocol class.
AllowAutoRedirect
ClientCertificates
ConnectionGroupName
Container
CookieContainer
Credentials
DesignMode
Events
PreAuthenticate
Proxy
RequestEncoding
Site
Timeout
Url
UserAgent
BeginInvoke
Starts an asynchronous invocation of a method of a HTTP Web service.
Return Value: An System.IAsyncResult which can be passed to System.Web.Services.Protocols.HttpSimpleClientProtocol.Endlnvoke(System.IAsyncResult) to obtain the return values from the Web Service method.
The methodName parameter is used to find the types of the parameters and return values of the method that is invoking System.Web.Services.Protocols.HttpSimpleClientProtocol.BeginInvoke(System.String,System.String,System.Object[ ],System.AsyncCallback,System.Object). It is also used to find custom attributes which may have been added to the method. The name of the Web Service method. The url to use when creating theSystem.Net.WebRequest. An array of objects containing the parameters to pass to the Web Service method. The order of the values in the array correspond to the order of the parameters in the calling method of the derived class. The delegate to call when the asynchronous method call is complete. If callback is null, the delegate is not called. Additional information supplied by a client.
EndInvoke
Completes asynchronous invocation of a Web Service method using HTTP.
Return Value: An array of objects containing the return value and any by reference or out parameters for the Web Service method. The System.IAsyncResult returned from System.Web.Services.Protocols.HttpSimpleClientProtocol.BeginInvoke(System.String,System.String,System.Object[ ],System.AsyncCallback,System.Object).
Invoke
Invokes a Web Service method using HTTP.
Return Value: An array of objects containing the return value and any by-reference or out parameters of the derived class method.
The methodName is used to find the types of the parameters and return values of the method that is invoking System.Web.Services.Protocols.HttpSimpleClientProtocol.Invoke(System.String,System.String,System.Object[ ]). It is also used to find custom attributes which may have been added to the method. The name of the Web Service method in the derived class that is invoking System.Web.Services.Protocols.HttpSimpleClientProtocol.Invoke(System.String,System.String,System.Object[ ]). The URL of the Web Service method the client is requesting. An array of objects containing the parameters to pass to the remote Web service. The order of the values in the array correspond to the order of the parameters in the calling method of the derived class.
HttpWebClientProtocol class (System.Web.Services.Protocols)
ToString
Description
When overridden in a derived class, provides support for client proxies invoking Web Services using HTTP.
ASP.NET incorporates two distinct functionalities of Web Services: building ASP.NET Web Services and building Web Service clients. If you build a Web Service client using ASP.NET, you must create a proxy class deriving indirectly or directly from System.Web.Services.Protocols.HttpWebClientProtocol for the Web Service you want to call.
HttpWebClientProtocol
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.HttpWebClientProtocol class.
AllowAutoRedirect
ToString
Gets or sets whether the client automatically follows server redirects.
If a client sends authentification information, such as a user name and password, you do not want to enable the server to redirect, because this can compromise security.
ClientCertificates
ToString
Gets the collection of client certificates.
Allows a client to pass one or more client certificates, also known as Authenticode X.509 v.3 certificates, when calling a Web Service method. If the Web Service method has been configured to use client certificates, a client certificate can be used as one mechanism for authenticating a client. For details on setting up client certificates, see the Internet Information Server (IIS) documentation.
ConnectionGroupName
Container
CookieContainer
ToString
Description
Gets or sets the collection of cookies.
If a Web Service method uses session state, then a cookie is passed back to the Web Service client that uniquely identifies the session for that Web Service client. In order for the Web Service client to receive that cookie, a new instance of System.Net.CookieContainer must be created and assigned to the System.Web.Services.Protocols.HttpWebClientProtocol.CookieContainer property before calling the Web Service method.
Credentials
DesignMode
Events
PreAuthenticate
Proxy
ToString
Description
Gets or sets proxy information for making a Web Service request through a firewall.
Use the System.Web.Services.Protocols.HttpWebClientProtocol.Proxy property if a client needs to use different proxy settings than those in the system settings. You can use the System.Net.WebProxy class to set the proxy settings, because it implements System.Net.IWebProxy.
RequestEncoding
Site
Timeout
Url
UserAgent
ToString
Description
Gets or sets the value for the user agent header that is sent with each request.
The user agent string allows a Web server to identify the client.
GetWebRequest
Creates a System.Net.WebRequest instance for the specified URI.
Return Value: The System.Net.WebRequest instance. The System.Uri for creating the System.Net.WebRequest.
GetWebResponse
Returns a response from a synchronous request to a Web Service method.
Return Value: The System.Net.WebResponse instance. The System.Net.WebRequest to get the response from.
GetWebResponse
Returns a response from an asynchronous request to a Web Service method.
Return Value: The System.Net.WebResponse instance. The System.Net.WebRequest to get the response from. The System.IAsyncResult to pass to System.Net.HttpwebRequest.EndGetResponse(System.IAsyncResult). when the response has completed.
LogicalMethodInfo class (System.Web.Services.Protocols)
ToString
Description
Represents the attributes and metadata for a Web Service method. This class cannot be inherited.
System.Web.Services.Protocols.LogicalMethodInfo is used primarily by a SOAP extension to interrogate the details of the Web Service method an SOAP extension is configured to run with. Depending on how the SOAP extension is configured to run, the SOAP extension can find out details about the Web Service method in the System.Web.Services.Protocols.SoapExtension.GetInitializer(System.Web.Services.Protocols.LogicalMethodInfo,System.Web.Services.Protocols.SoapExtensionAttribute) method of System.Web.Services.Protocols.SoapExtension that takes an System.Web.Services.Protocols.LogicalMethodInfo. The System.Web.Services.Protocols.LogicalMethodInfo provides details such as the Web Service method's parameters by accessing the System.Web.Services.Protocols.LogicalMethodInfo.Parameters property and any custom attributes applied to the Web Service method using the System.Web.Services.Protocols.LogicalMethodInfo.GetCustomAttributes(System.Type) property.
LogicalMethodInfo
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.LogicalMethodInfo class with the System.Reflection.MethodInfo object passed. A System.Reflection.MethodInfo to initialize the properties of System.Web.Services.Protocols.LogicalMethodInfo common to System.Reflection.MethodInfo.
AsyncCallbackParameter
ToString
Gets the parameter information for the AsyncCallback parameter of a Begin method in an asynchronous invocation.
The asynchronous design pattern in the common language runtime involves calling a Begin method to start the asynchronous method invocation and an End method to complete the invocation. The Begin method takes two additional parameters besides the parameters defined by the method: one for a delegate and one for any state information that needs to be passed on to the delegate. This property represents the parameter for the delegate with a parameter name of AsyncCallback.
AsyncResultParameter
ToString
Gets the return value of a Begin asynchronous method invocation.
The asynchronous design pattern in the common language runtime involves calling a Begin method to start the asynchronous method invocation and an End method to complete the invocation. The Begin method typically returns immediately with an object implementing the System.IAsyncResult interface, which can then be passed to the End method at a later time to complete the asynchronous method invocation. The returned object implementing the System.IAsyncResult interface is represented by this property.
AsyncStateParameter
ToString
Gets the parameter information for the AsyncState parameter of a Begin method in an asynchronous invocation.
The asynchronous design pattern in the common language runtime involves calling a Begin method to start the asynchronous method invocation and an End method to complete the invocation. The Begin method takes two additional parameters besides the parameters defined by the method: one for a delegate and one for any state information that needs to be passed on to the delegate. This property represents the state information that needs to be passed into the delegate.
BeginMethodInfo
ToString
Gets the attributes and metadata for a Begin method of an asynchronous invocation to a method.
CustomAttributeProvider
ToString
Gets the custom attributes applied to the method.
DeclaringType
ToString
Gets the class that declares the method represented by the instance of System.Web.Services.Protocols.LogicalMethodInfo.
The System.Web.Services.Protocols.LogicalMethodInfo.DeclaringType property retrieves a reference to a System.Type for the type that declares this member. A member of a class (or interface) is either declared or inherited from a base class (or interface). The returned System.Type might not be the same as the System.Type of the class implementing the Web Service (if that class derives from a base class and the method represented by this class is declared in that base class then the System.Type returned is the base class).
EndMethodInfo
ToString
Gets the attributes and metadata for an End method of an asynchronous invocation to a method.
InParameters
ToString
Gets the parameters passed into the method represented by the instance of System.Web.Services.Protocols.LogicalMethodInfo.
Use an instance of System.Reflection.ParameterInfo to obtain information about the parameter's data type, default value, and so on.
IsAsync
ToString
Gets a value indicating whether the method represented by the instance of System.Web.Services.Protocols.LogicalMethodInfo is invoked asynchronously.
IsVoid
ToString
Gets a value indicating whether the return type for the method represented by the instance of System.Web.Services.Protocols.LogicalMethodInfo is void.
MethodInfo
ToString
Gets the attributes and metadata for a synchronous method.
Name
ToString
Gets the name of the method represented by this instance.
OutParameters
ToString
Gets the out parameters for the method.
Use an instance of System.Reflection.ParameterInfo to obtain information about the parameter's data type, default value, and so on.
Parameters
ToString
Gets the parameters for the method.
Use an instance of System.Reflection.ParameterInfo to obtain information about the parameter's data type, default value, and so on.
ReturnType
ToString
Gets the return type of this method.
ReturnTypeCustomAttributeProvider
ToString
Gets the custom attributes for the return type.
BeginInvoke
Begins an asynchronous invocation of the method represented by this System.Web.Services.Protocols.LogicalMethodInfo instance.
Return Value: An System.IAsyncResult which is passed to System.Web.Services.Protocols.LogicalMethodInfo.EndInvoke(System.Object,System.IAsyncResult) to obtain the return values from the remote method call. The instance of the object to invoke the method on. An argument list for the invoked method. This is an array of objects with the same number, order, and type as the parameters of the method. If the method does not require any parameters, values should be null. The delegate to call when the asynchronous invoke is complete. If callback is null, the delegate is not called. State information that is passed on to the delegate.
Create
Creates an array of System.Web.Services.Protocols.LogicalMethodInfo, given an array of System.Reflection.MethodInfo that can contain information about both asynchronous and synchronous methods.
Return Value: An array of System.Web.Services.Protocols.LogicalMethodInfo, representing the methods within methodInfos. An array of System.Reflection.MethodInfo representing the asynchronous and synchronous methods to create System.Web.Services.Protocols.LogicalMethodInfo objects for.
Create
Creates an array of System.Web.Services.Protocols.LogicalMethodInfo, given an array of System.Reflection.MethodInfo, where the returned array of System.Web.Services.Protocols.LogicalMethodInfo can be restricted to only asynchronous or synchronous methods.
Return Value: An array of System.Web.Services.Protocols.LogicalMethodInfo representing the methods within methodInfos, filtered by the value of types. An array of System.Reflection.MethodInfo representing the asynchronous and synchronous methods to create System.Web.Services.Protocols.LogicalMethodInfo objects for. A bitwise combination of the System.Web.Services.Protocols.LogicalMethodTypes values. Determines whether just asynchronous or synchronous methods or both are included in the returned array of System.Web.Services.Protocols.LogicalMethodInfo.
EndInvoke
Ends an asynchronous invocation of the method represented by this System.Web.Services.Protocols.LogicalMethodInfo instance.
Return Value: An array of objects containing the return value and any by-reference or out parameters of the derived class method. The instance of the object to invoke the method on. The System.IAsyncResult returned from System.Web.Services.Protocols.LogicalMethodInfo.BeginInvoke(System.Object,System.Object[ ],System.AsyncCallback,System.Object).
GetCustomAttribute
Returns the first custom attribute applied to the type, if there are custom attributes applied to the type.
Return Value: An System.Object containing the first custom attribute applied to type. The System.Type that the custom attributes are applied to.
GetCustomAttributes
Returns the custom attributes applied to the specified type.
Return Value: An array of System.Object containing the custom attributes applied to type. The System.Type to get the custom attributes applied to.
Invoke
Invokes the method represented by this System.Web.Services.Protocols.LogicalMethodInfo instance.
Return Value: An array of type System.Object representing the return value and out parameters of the invoked method. The instance of the object to invoke the method on. An argument list for the invoked method. This is an array of objects with the same number, order, and type as the parameters of the method. If the method does not require any parameters, values should be null.
IsBeginMethod
Returns a value indicating whether the method passed in represents a begin method of an asynchronous invocation.
Return Value: true if methodInfo is a begin method of an asynchronous invocation; otherwise, false. The System.Reflection.MethodInfo to determine if it is a begin method of an asynchronous invocation.
IsEndMethod
Returns a value indicating whether the method passed in represents a end method of an asynchronous invocation.
Return Value: true if methodInfo is a end method of an asynchronous invocation; otherwise, false. The System.Reflection.MethodInfo to determine if it is a end method of an asynchronous invocation.
ToString
Returns a System.String that represents the current System.Web.Services.Protocols.LogicalMethodInfo.
Return Value: A System.String that represents the current System.Web.Services.Protocols.LogicalMethodInfo.
LogicalMethodTypes enumeration (System.Web.Services.Protocols)
ToString
Description
Specifies how the Web Service method was invoked.
ToString
Specifies the Web Service method is invoked asynchronously.
ToString
Specifies the Web Service method is invoked synchronously.
MatchAttribute class (System.Web.Services.Protocols)
ToString
Description
Represents the attributes of a match made using text pattern matching. This class cannot be inherited.
Text pattern matching allows a Web Service to leverage existing HTML content by parsing it using regular expressions. A Web Service specifies the content it wants to parse in a Service Description using match elements. These match elements specify several items: the regular expression for parsing the contents of an existing HTML page, whether the parsing must case-insensitive, and how many instances of content that matches the regular expression should be returned. When a client builds a proxy class using the Wsdl.exe tool, methods on the proxy class include a System.Web.Services.Protocols.MatchAttribute detailing the match elements found in the Service Description.
MatchAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.MatchAttribute class with the specified pattern.
Use this constructor to create and initialize a new instance of the System.Web.Services.Protocols.MatchAttribute class using the specified pattern. A string that represents the pattern to match.
Capture
ToString
Gets or sets a value that represents the index of a match within a grouping.
Group
ToString
Gets or sets a value that represents a grouping of related matches.
Use the System.Web.Services.Protocols.MatchAttribute.Group property to specify a group that a match belongs to.
IgnoreCase
ToString
Gets or sets a value that indicates whether the pattern to match is case insensitive.
MaxRepeats
ToString
Gets or sets the maximum number of values to return from the match.
A value of 1 returns only the first match. A value of −1 returns all matches. Additionally, a value of −1 equates to an ‘*’ in a regular expression.
Pattern
ToString
Gets or sets a regular expression that represents the pattern to match.
Use the System.Web.Services.Protocols.MatchAttribute.Pattern property to specify a regular expression that represents the value to match.
TypeId
MimeFormatter class (System.Web.Services.Protocols)
ToString
Description
MimeFormatter
Example Syntax:
ToString
CreateInstance
GetInitializer
GetInitializer
GetInitializers
GetInitializers
Initialize
MimeParameterReader class (System.Web.Services.Protocols)
ToString
Description
MimeParameterReader
Example Syntax:
ToString
Read
MimeParameterWriter class (System.Web.Services.Protocols)
ToString
Description
MimeParameterWriter
Example Syntax:
ToString
RequestEncoding
ToString
UsesWriteRequest
ToString
GetRequestUrl
InitializeRequest
WriteRequest
MimeReturnReader class (System.Web.Services.Protocols)
WriteRequest
Description
MimeReturnReader
Example Syntax:
WriteRequest
Read
NopReturnReader class (System.Web.Services.Protocols)
ToString
Description
NopReturnReader
Example Syntax:
ToString
GetInitializer
Initialize
Read
PatternMatcher class (System.Web.Services.Protocols)
ToString
Description
PatternMatcher
Example Syntax:
ToString
Match
SoapClientMessage class (System.Web.Services.Protocols)
ToString
Description
Represents the data in a SOAP request sent or a SOAP response received by a Web Service client at a specific System.Web.Services.Protocols.SoapMessageStage for a Web Service method.
Action
ToString
Gets the SOAPAction HTTP request header field for the SOAP request or SOAP response.
The System.Web.Services.Protocols.SoapClientMessage.Action property is availavable in any System.Web.Services.Protocols.SoapMessageStage.
Client
ToString
Gets an instance of the client proxy class, which derives from System.Web.Services.Protocols.SoapHttpClientProtocol.
The System.Web.Services.Protocols.SoapClientMessage.Client property can be accessed during any System.Web.Services.Protocols.SoapMessageStage
ContentType
Exception
Headers
MethodInfo
ToString
Description
Gets a representation of the method prototype for the Web Service method for which the SOAP request is intended.
Although the System.Web.Services.Protocols.SoapClientMessage.MethodInfo property can be accessed during any stage, the method information is only available during System.Web.Services.Protocols.SoapMessageStage.AfterDeserialize and System.Web.Services.Protocols.SoapMessageStage.BeforeSerialize.
OneWay
ToString
Gets a value indicating whether the client waits for the server to finish processing a Web Service method.
A System.Web.Services.Protocols.SoapDocumentMethodAttribute or System.Web.Services.Protocols.SoapRpcMethodAttribute applied to a Web Service method or Web Service client can specify whether the Web Service method is one way or not by setting the System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay property of the attribute.
Stage
Stream
Url
ToString
Description
Gets the URL of the Web Service.
The System.Web.Services.Protocols.SoapClientMessage.Url property can be accessed during any System.Web.Services.Protocols.SoapMessageStage EnsureInStage
Asserts that the current System.Web.Services.Protocols.SoapMessageStage stage is a stage where in parameters are available. If not, an exception is thrown.
For Web Service clients, the in parameters are available prior to the SOAP request serialization process in the System.Web.Services.Protocols.SoapMessageStage.BeforeSerialize stage. The System.InvalidOperationException is thrown if System.Web.Services.Protocols.SoapClientMessage.EnsureInStage method is invoked in any other System.Web.Services.Protocols.SoapMessageStage.
EnsureOutStage
Asserts that the current System.Web.Services.Protocols.SoapMessageStage stage is a stage where out parameters are available. If not, an exception is thrown.
For Web Service clients, the out parameters are available after the SOAP response deserialization process in the System.Web.Services.Protocols.SoapMessageStage.AfterDeserialize stage. The System.InvalidOperationException is thrown if System.Web.Services.Protocols.SoapClientMessage.EnsureOutStage method is invoked in any other System.Web.Services.Protocols.SoapMessageStage.
SoapDocumentMethodAttribute class (System.Web.Services.Protocols)
ToString
Description
Applying the optional System.Web.Services.Protocols.SoapDocumentMethodAttribute to a Web Service method alters the format of the SOAP request or response sent to and from a Web Service method.
Web Services Description Language (WSDL) defines two styles for how a Web Service method, which it calls an operation, can be encoded in a SOAP request or a SOAP response: RPC and Document. The Document style refers to encoding the Web Service method as described in an XSD schema. If Document style is used, the Service Description for the Web Service, which is in WSDL, defines XSD schemas for both SOAP requests and SOAP responses to the Web Service method. A Web Service set to the Document encoding style expects clients to pass the XML just as it is defined in these XSD schemas.
SoapDocumentMethodAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapDocumentMethodAttribute class.
SoapDocumentMethodAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapDocumentMethodAttribute class setting the System.Web.Services.Protocols.SoapDocumentMethodAttribute.Action property to action. The intent of the SOAP request. Sets the System.Web.Services.Protocols.SoapDocumentMethodAttribute.Action property.
Action
ToString
Gets or sets the intent of the SOAP request.
The System.Web.Services.Protocols.SoapDocumentMethodAttribute.Action property forms the SOAPAction HTTP Header Field for the HTTP Request.
Binding
ToString
Gets or sets the binding a Web Service method is implementing a operation for.
A binding, as defined by Web Services Description Language(WSDL), is similar to an interface, in that it defines a concrete set of operations. With respect to ASP.NET Web Services, each Web Service method is an operation within a binding. Web Service methods are members of either the default binding for a Web Service or in a binding specified within a System.Web.Services.WebServiceBindingAttribute applied to a Web Service. A Web Service can implement multiple bindings, by applying multiple System.Web.Services.WebServiceBindingAttribute attributes to a Web Service.
OneWay
ToString
Gets or sets whether a Web Service client waits for the Web server to finish processing a Web Service method.
When a Web Service method sets the System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay property to true, the Web Service client does not have to wait for the Web server to finish processing the Web Service method. As soon as the Web server has deserialized the System.Web.Services.Protocols.SoapServerMessage, but before invoking the Web Service method, the server returns an HTTP 202 status code. A HTTP 202 status code indicates to the client that the Web server has started processing of the message. Therefore, a Web Service client receives no acknowledgment that the Web server successfully processed the message.
ParameterStyle
ToString
Gets or sets whether parameters are wrapped within a single element beneath the Body element in the XML portion of a SOAP message.
RequestElementName
ToString
Gets or sets the XML element associated with the SOAP request for a Web Service method.
The System.Web.Services.Protocols.SoapDocumentMethodAttribute.RequestElementName defines the XML element used to wrap the parameters beneath the Body element of the SOAP request when System.Web.Services.Protocols.SoapDocumentMethodAttribute.ParameterStyle is System.Web.Services.Protocols.SoapParameterStyle.Wrapped. This is reflected in the XSD schema representing the SOAP request to the Web Service method within the Web Service's Service Description.
RequestNamespace
ToString
Gets or sets the namespace associated with the SOAP request for a Web Service method.
System.Web.Services.Protocols.SoapDocumentMethodAttribute.RequestNamespace is used in the XSD schema for the Web Service method within its Service Description.
ResponseElementName
ToString
Gets or sets the XML element associated with the SOAP response for a Web Service method.
The System.Web.Services.Protocols.SoapDocumentMethodAttribute.ResponseElementName defines the XML element used to wrap the parameters beneath the Body element of the SOAP response when System.Web.Services.Protocols.SoapDocumentMethodAttribute.ParameterStyle is System.Web.Services.Protocols.SoapParameterStyle.Wrapped. This is reflected in the XSD schema representing the SOAP response to the Web Service method within the Web Service's Service Description.
ResponseNamespace
ToString
Gets or sets the XML namespace associated with the SOAP response for a Web Service method.
The System.Web.Services.Protocols.SoapDocumentMethodAttribute.ResponseNamespace property is used in the XSD schema for the Web Service method in its Service Description.
TypeId
Use
ToString
Description
Gets or sets the parameter encoding for a Web Service method within the XML portion of a SOAP message.
The Web Services Description Language (WSDL) defines two parameter encoding styles: System.Web.Services.Description.SoapBindingUse.Encoded and System.Web.Services.Description.SoapBindingUse.Literal.
SoapDocumentServiceAttribute class (System.Web.Services.Protocols)
ToString
Description
Applying the optional System.Web.Services.Protocols.SoapDocumentServiceAttribute to a Web Service sets the default format of SOAP requests and responses sent to and from Web Service methods within the Web Service.
The System.Web.Services.Protocols.SoapDocumentServiceAttribute allows you to set the default encoding styles for Web Service methods within a Web Service. If an individual Web Service method needs to change these defaults, apply a System.Web.Services.Protocols.SoapDocumentMethodAttribute to that Web Service method.
SoapDocumentServiceAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapDocumentServiceAttribute class setting all properties to their defaults.
SoapDocumentServiceAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapDocumentServiceAttribute class setting the parameter encoding. The parameter encoding of the Web Service. Sets the System.Web.Services.Protocols.SoapDocumentServiceAttribute.Use property.
SoapDocumentServiceAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapDocumentServiceAttribute class setting the parameter encoding and whether parameters are wrapped within a single element under the Body element within the XML portion of SOAP requests and responses. The parameter encoding style. Sets the System.Web.Services.Protocols.SoapDocumentServiceAttribute.Use property. Sets whether parameters are wrapped withn a single XML element under the Body element within the XML portion of SOAP requests and responses to Web Service methods within the Web Service. Sets the System.Web.Services.Protocols.SoapDocumentServiceAttribute.ParameterStyle property.
ParameterStyle
ToString
Gets or sets the default for Web Service methods within the Web Service whether parameters are wrapped within a single element beneath the Body element in the XML portion of a SOAP message.
RoutingStyle
ToString
TypeId
Use
ToString
Description
Gets or sets the default parameter encoding for a Web Service.
The Web Services Description Language (WSDL) defines two parameter encoding styles: System.Web.Services.Description.SoapBindingUse.Encoded and System.Web.Services.Description.SoapBindingUse.Literal.
SoapException class (System.Web.Services.Protocols)
ToString
Description
The exception that is thrown when a Web Service method is called over Simple Object Access Protocol (SOAP) and an exception occurs.
The System.Web.Services.Protocols.SoapException can either be thrown by the common language runtime or by a Web Service method. The common language runtime can throw a System.Web.Services.Protocols.SoapException if a response to a request is not formatted correctly. Web Service methods can generate a System.Web.Services.Protocols.SoapException by simply throwing an exception within the Web Service method. If the client accessed the method over SOAP, the exception is caught on the server and wrapped inside a new System.Web.Services.Protocols.SoapException. The SoapException thrown has the following property values: Property Value System.Exception.Message The System.Exception.Message property of the original exception.
ToString
Specifies a SOAP fault code representing a client call was not formatted correctly or did not contain the appropriate information.
An example of when a System.Web.Services.Protocols.SoapException.ClientFaultCode can be generated, is when a client call lacks proper authentication or payment information. It is generally an indication that the client call should not be resent without change.
ToString
Gets an System.Xml.XmlQualifiedName representing the System.Web.Services.Protocols.SoapException.Detail element of a SOAP Fault code.
In building an System.Xml.XmlNode for the System.Web.Services.Protocols.SoapException.Detail property, the System.Xml.XmlQualifiedName.Name and System.Xml.XmlQualifiedName.Namespace properties of System.Web.Services.Protocols.SoapException.DetailElementName can be used to ensure consistancy with the SOAP specification.
ToString
A SOAP Fault Code representing a SOAP element marked with the MustUnderstand attribute was not processed.
Not all SOAP elements require processing by the server. However, if a SOAP element is marked with the MustUnderstand attribute equal to 1, processing is required. Failure to process the element, generates a System.Web.Services.Protocols.SoapException with a System.Web.Services.Protocols.SoapException.MustUnderstandFaultCode.
ToString
Specifies a SOAP fault code representing an error occurred during the processing of a client call on the server, where the problem was not due to the message contents.
A System.Web.Services.Protocols.SoapException.ServerFaultCode might occur for example, if a server being called, couldn't respond to a request due to network problems. Typically, with this type of exception, the client call may succeed later.
ToString
A SOAP fault code representing an invalid namespace for a SOAP Envelope was found during the processing of the SOAP message.
A SOAP Envelope is the top-level element of a XML document representing a SOAP message.
SoapException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapException class that sets the exception message and exception code. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property.
SoapException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapException class that sets the exception message, exception code and a reference to the root cause of the exception. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. A reference to the root cause of the exception. Sets the System.Exception.InnerException property.
SoapException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapException class that sets the exception message, exception code and the piece of code that caused the exception. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property.
SoapException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapException class that sets the exception message, exception code, the piece of code that casued the exception and a reference to the root cause of the exception. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property. A reference to the root cause of an exception. Sets the System.Exception.InnerException property.
SoapException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapException class that sets the exception message, exception code, piece of code that caused the exception and application specific exception information. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property. The application specific exception information. Sets the System.Web.Services.Protocols.SoapException.Detail property.
SoapException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapException class that sets the exception message, exception code, piece of code that caused the exception, application specific exception information and a reference to the root cause of the exception. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property. The application specific exception information. Sets the System.Web.Services.Protocols.SoapException.Detail property. A reference to the root cause of the exception. Sets the System.Exception.InnerException property.
SoapException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapException class that sets the exception message, exception code, piece of code that caused the exception, application specific exception information and optional exception information. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property. The application specific exception information. Sets the System.Web.Services.Protocols.SoapException.Detail property. Optional exception information. Sets the System.Web.Services.Protocols.SoapException.OtherElements property.
SoapException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapException class that sets the exception message, exception code, piece of code that caused the exception, application specific exception information, optional exception information, and a reference to the root cause of the exception. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property. The application specific exception information. Sets the System.Web.Services.Protocols.SoapException.Detail property. Optional exception information. Sets the System.Web.Services.Protocols.SoapException.OtherElements property. A reference to the root cause of the exception. Sets the System.Exception.InnerException property.
Actor
ToString
Gets the piece of code that caused the exception.
System.Web.Services.Protocols.SoapException.Actor can only be set using one of the constructors that accept an System.Web.Services.Protocols.SoapException.Actor argument.
Code
ToString
Gets the type of SOAP fault code.
System.Web.Services.Protocols.SoapException.Code can only be set when creating a new instance of the System.Web.Services.Protocols.SoapException class.
Detail
ToString
Gets an System.Xml.XmlNode representing the application specific error information.
System.Web.Services.Protocols.SoapException.Detail can be set using one of the class constructors that accept a System.Web.Services.Protocols.SoapException.Detail value.
HelpLink
HResult
InnerException
Message
OtherElements
ToString
Description
Gets an array of System.Xml.XmlNode with the optional error information.
System.Web.Services.Protocols.SoapException.OtherElements can be set using one of the class constructors that accept an argument for System.Web.Services.Protocols.SoapException.OtherElements.
Source
StackTrace
TargetSite
SoapExtension class (System.Web.Services.Protocols)
ToString
Description
Represents the ase class for SOAP extensions in ASP.NET Web Services.
ASP.NET Web Services allows a SOAP-related infrastructure to be built by means of an extensibility mechanism. The ASP.NET SOAP extension architecture revolves around an extension that can inspect or modify a message at specific stages in message processing on either the client or the server.
SoapExtension
Example Syntax:
ToString
ChainStream
When overridden in a derived class, allows a SOAP extension access to the memory buffer containing the SOAP request or response.
Return Value: A System.IO.Stream representing a new memory buffer that this SOAP extension can modify.
System.Web.Services.Protocols.SoapExtension.ChainStream(System.IO.Stream) ensures that SOAP extensions with the highest priority can modify the actual data closest to the SOAP message sent or returned over the wire. For instance, you probably would not want a compression SOAP extension to compress the data prior to an encryption SOAP extension encrypted the data. Doing so might lead to an inefficiently compressed data packet sent over the wire. A memory buffer containing the SOAP request or response.
GetInitializer
When overridden in a derived class, allows a SOAP extension to initialize data specific to a class implementing a Web Service at a one-time performance cost.
Return Value: The System.Object that the SOAP extension initializes to be cached.
The overload of System.Web.Services.Protocols.SoapExtension.GetIntializer that gets called by the ASP.NET Web Services infrastructure depends on how the SOAP extension was specified. There are two methods for specifying a SOAP extension: apply a custom attribute, deriving from System.Web.Services.Protocols.SoapExtensionAttribute, to the individual Web Service method or add a reference in either the web.config or app.config configuration files. If you add a reference to one of the configuration files, the SOAP extension runs for all Web Services within the scope of that configuration file. The ASP.NET Web Services infrastructure invokes the System.Web.Services.Protocols.GetInitializer overload that passes in a System.Type; otherwise the ASP.NET Web Services infrastructure invokes the System.Web.Services.Protocols.SoapExtension.GetInitializer(System.Web.Services.Protocols.LogicalMethodInfo,System.Web.Services.Protocols.SoapExtensionAttribute) that passes in a System.Web.Services.Protocols.LogicalMethodInfo and a System.Web.Services.Protocols.SoapExtensionAttribute. The type of the class implementing the Web Service that a SOAP extension is applied to.
GetInitializer
When overridden in a derived class, allows a SOAP extension to initialize data specific to a Web Service method using an attribute applied to the Web Service method at a one-time performance cost.
Return Value: The System.Object that the SOAP extension initializes to be cached.
If the SOAP extension is configured using a configuration file see the System.Web.Services.Protocols.SoapExtension.GetInitialzier overload that accepts a System.Type. A System.Web.Services.Protocols.LogicalMethodInfo object representing the specific function prototype for the Web Service method the SOAP extension is applied to. The instance of the System.Web.Services.Protocols.SoapExtensionAttribute applied to the Web Service method.
Initialize
When overridden in a derived class, allows a SOAP extension to initialize itself using the data cached in the System.Web.Services.Protocols.SoapExtension.GetInitializer(System.Web.Services.Protocols.LogicalMethodInfo,System.Web.Services.Protocols.SoapExtensionAttribute) method.
A SOAP extension has three opportunities to initialize data and they all have different purposes: Class constructor—The class constructor is called every time a SOAP extension is instantiated and is typically used to initialize member variables. The System.Object returned from System.Web.Services.Protocols.SoapExtension.GetInitializer(System.Web.Services.Protocols.LogicalMethodInfo,System.Web.Services.Protocols.SoapExtensionAttribute) cached by ASP.NET Web Services.
ProcessMessage
When overridden in a derived class, allows a SOAP extension to receive a System.Web.Services.Protocols.SoapMessage to process at each System.Web.Services.Protocols.SoapMessageStage.
System.Web.Services.Protocols.SoapExtension.ProcessMessage(System.Web.Services.Protocols.SoapMessage) is called at all System.Web.Services.Protocols.SoapMessageStage stages for SOAP extensions applied to both ASP.NET Web Service clients and ASP.NET Web Services. At each System.Web.Services.Protocols.SoapMessageStage, an instance of a class deriving from System.Web.Services.Protocols.SoapMessage is passed to System.Web.Services.Protocols.SoapExtension.ProcessMessage(System.Web.Services.Protocols.SoapMessage). If the SOAP extension is running on the Web Service client, then a System.Web.Services.Protocols.SoapClientMessage object is passed into System.Web.Services.Protocols.SoapExtension.ProcessMessage(System.Web.Services.Protocols.SoapMessage); otherwise a System.Web.Services.Protocols.SoapServerMessage object is passed in. The System.Web.Services.Protocols.SoapMessage to process.
SoapExtensionAttribute class (System.Web.Services.Protocols)
ToString
Description
When overridden in a derived class, specifies the SOAP extension should be applied to a Web Service method.
ASP.NET Web Services enables applying SOAP extensions to a Web Service method by applying an attribute. When a custom extension attribute is added to a Web Service method or a proxy class client, ASP.NET Web Services invokes the associated extension at the appropriate time. An extension attribute is a custom attribute class deriving from System.Web.Services.Protocols.SoapExtensionAttribute. Derived attributes must override the System.Web.Services.Protocols.SoapExtensionAttribute.ExtensionType property to return the type of extension that is associated with the attribute.
SoapExtensionAttribute
Example Syntax:
ToString
ExtensionType
ToString
When overridden in a derived class, gets the System.Type of the SOAP extension.
Derived classes must override the System.Web.Services.Protocols.SoapExtensionAttribute.ExtensionType property to return the System.Type of SOAP extension.
Priority
ToString
When overridden in a derived class, gets or set the priority of the SOAP extension.
TypeId
SoapHeader class (System.Web.Services.Protocols)
ToString
Description
When overridden in a derived class, represents the content of a SOAP header.
SOAP headers offer a method for passing data to and from a Web Service method not directly related to a Web Service method's primary functionality. For instance, a Web Service may contain several Web Service methods that each require a custom authentication scheme. Instead of adding parameters to each Web Service method for the custom authentication scheme, a System.Web.Services.Protocols.SoapHeaderAttribute, referring to a class deriving from System.Web.Services.Protocols.SoapHeader, can be applied to each Web Service method. The implementation for the class deriving from System.Web.Services.Protocols.SoapHeader handles the custom authentication scheme. In this manner, the Web Service method implements only the functionality specific to it and adds additional functionality through the use of a SOAP header.
SoapHeader
Example Syntax:
ToString
Actor
ToString
Gets or sets the recipient of the SOAP header.
According to the SOAP specification, the recipient (commonly called the SOAP actor attribute) does not have to be the same for the Header and Body elements of a SOAP message. For a Web Service method, the required Body element of a SOAP message represents the parameters and return values of the Web Service method. If a Header element exists in the SOAP message, it represents additional data that can be sent to and from the Web Service method. The recipient of that data, known as the Actor, can be a different URI than the URI for the Web Service method.
DidUnderstand
ToString
Gets or sets a value indicating whether a Web Service method properly processed a SOAP header.
For SOAP headers defined by a Web Service, ASP.NET Web Services assumes the Web Service method properly processed the SOAP header by setting the initial value of System.Web.Services.Protocols.SoapHeader.DidUnderstand to true. For SOAP headers not defined by the Web Service, the initial value is false. If ASP.NET Web Services detects SOAP headers passed to a Web Service method with System.Web.Services.Protocols.SoapHeader.DidUnderstand set to false after the method returns, a System.Web.Services.Protocols.SoapHeaderException is thrown back to the Web Service client instead of the results from the Web Service method.
EncodedMustUnderstand
ToString
Gets or sets the value of the mustUnderstand attribute for the SOAP header.
Valid values for the System.Web.Services.Protocols.SoapHeader.EncodedMustUnderstand property are 0 and 1, whereas setting the property to false or true equates to setting the property to 0 or 1, respectively.
MustUnderstand
ToString
Gets or sets a value indicating whether the System.Web.Services.Protocols.SoapHeader must be understood.
When a Web Service client adds a SOAP header to a Web Service method call with the System.Web.Services.Protocols.SoapHeader.MustUnderstand property set to true, the Web Service method must set the System.Web.Services.Protocols.SoapHeader.DidUnderstand property to true; otherwise, a System.Web.Services.Protocols.SoapHeaderException is thrown back to the Web Service client by ASP.NET Web Services.
SoapHeaderAttribute class (System.Web.Services.Protocols)
ToString
Description
This attribute is applied to a Web Service or a Web Service client to specify a SOAP Header the Web Service or Web Service client wants to process. This class cannot be inherited.
The basic steps to receiving and processing a SOAP header are: Create a class deriving from System.Web.Services.Protocols.SoapHeader representing the data passed in the SOAP header.
SoapHeaderAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapHeaderAttribute class setting the member of the Web Service class representing the SOAP header contents.
A Web Service client or Web Service can specify the SOAP headers it wants to process for specific Web Service methods by applying a System.Web.Services.Protocols.SoapHeaderAttribute to the Web Service method in the Web Service class or the corresponding method in the proxy class. In order for the Web Service method to receive the contents of the SOAP header, a member is added to the Web Service class of a System.Type derived from System.Web.Services.Protocols.SoapHeader. Likewise, a Web Service client adds a member to the proxy class deriving from System.Web.Services.Protocols.SoapHeader. That System.Type deriving from System.Web.Services.Protocols.SoapHeader represents the contents of the SOAP header and is created by the developer of the Web Service or Web Service client that wants to receive the SOAP header. Once the class is created, a System.Web.Services.Protocols.SoapHeaderAttribute can be applied to the Web Service method or corresponding method in the Web Service client proxy class specifing the member to receive the SOAP header contents with the memberName parameter to this constructor or the System.Web.Services.Protocols.SoapHeaderAttribute.MemberName property. Member of the Web Service class representing the SOAP header contents. Sets the System.Web.Services.Protocols.SoapHeaderAttribute.MemberName property.
Direction
ToString
Gets or sets whether the SOAP header is intended for the Web Service or the Web Service client or both.
MemberName
ToString
Gets or sets the member of the Web Service class representing the SOAP header contents.
A Web Service client or Web Service can specify the SOAP headers it wants to process for specific Web Service methods by applying a System.Web.Services.Protocols.SoapHeaderAttribute to the Web Service method in the Web Service class or the corresponding method in the proxy class. In order for the Web Service method to receive the contents of the SOAP header, a member is added to the Web Service class of a System.Type derived from System.Web.Services.Protocols.SoapHeader. Likewise, a Web Service client adds a member to the proxy class deriving from System.Web.Services.Protocols.SoapHeader. That System.Type deriving from System.Web.Services.Protocols.SoapHeader represents the contents of the SOAP header and is created by the developer of the Web Service or Web Service client that wants to receive the SOAP header. Once the class is created, a System.Web.Services.Protocols.SoapHeaderAttribute can be applied to the Web Service method or corresponding method in the Web Service client proxy class specifing the member to receive the SOAP header contents with the System.Web.Services.Protocols.SoapHeaderAttribute.MemberName property.
Required
ToString
Gets or sets a value indicating whether the SOAP header must be understood and processed by the recipient Web Service or Web Service client.
When the System.Type of the member (represented by the System.Web.Services.Protocols.SoapHeaderAttribute.MemberName property) is either System.Web.Services.Protocols.SoapHeader or System.Web.Services.Protocols.SoapUnknownHeader, the System.Web.Services.Protocols.SoapHeaderAttribute.Required property must be false. For types that derive from System.Web.Services.Protocols.SoapHeader, it is fine for the System.Web.Services.Protocols.SoapHeaderAttribute.Required property to be true or false.
TypeId
SoapHeaderCollection class (System.Web.Services.Protocols)
ToString
Description
Contains a collection of System.Web.Services.Protocols.SoapHeader objects.
SoapHeaderCollection
Example Syntax:
ToString
Count
InnerList
Item
ToString
Description
Gets or sets the System.Web.Services.Protocols.SoapHeader at position index of the System.Web.Services.Protocols.SoapHeaderCollection.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[index]. The zero-based index of the System.Web.Services.Protocols.SoapHeader to get or set.
List
Add
Adds a System.Web.Services.Protocols.SoapHeader to the System.Web.Services.Protocols.SoapHeaderCollection.
Return Value: The position into which the System.Web.Services.Protocols.SoapHeader was inserted. The System.Web.Services.Protocols.SoapHeader to add to the System.Web.Services.Protocols.SoapHeaderCollection.
Contains
Determines whether the System.Web.Services.Protocols.SoapHeaderCollection contains a specific System.Web.Services.Protocols.SoapHeader.
Return Value: true if the System.Web.Services.Protocols.SoapHeader is found in the System.Web.Services.Protocols.SoapHeaderCollection; otherwise, false. The System.Web.Services.Protocols.SoapHeader to locate in the System.Web.Services.Protocols.SoapHeaderCollection.
CopyTo
Copies the elements of the System.Web.Services.Protocols.SoapHeaderCollection to an System.Array, starting at a particular System.Array index. The one-dimensional System.Array that is the destination of the elements copied from System.Web.Services.Protocols.SoapHeaderCollection. The System.Array must have zero-based indexing. The zero-based index in array at which copying begins.
IndexOf
Determines the index of the SoapHeader in the SoapHeaderCollection.
Return Value: The index of header if found in the System.Web.Services.Protocols.SoapHeaderCollection; otherwise, −1. The System.Web.Services.Protocols.SoapHeaderto locate in the System.Web.Services.Protocols.SoapHeaderCollection.
Insert
Inserts a System.Web.Services.Protocols.SoapHeader into the System.Web.Services.Protocols.SoapHeaderCollection at the specified index.
If index equals the number of items in the collection, then the System.Web.Services.Protocols.SoapHeader is appended to the end. The zero-based index at which the System.Web.Services.Protocols.SoapHeader is inserted into the System.Web.Services.Protocols.SoapHeaderCollection. The System.Web.Services.Protocols.SoapHeader inserted into the System.Web.Services.Protocols.SoapHeaderCollection.
Remove
Removes the first occurrence of a specific System.Web.Services.Protocols.SoapHeader from the System.Web.Services.Protocols.SoapHeaderCollection.
The System.Web.Services.Protocols.SoapHeader elements that follow the removed System.Web.Services.Protocols.SoapHeader move up to occupy the vacated spot. The System.Web.Services.Protocols.SoapHeader to remove from the System.Web.Services.Protocols.SoapHeaderCollection.
SoapHeaderDirection enumeration (System.Web.Services.Protocols)
ToString
Description
Specifies whether the recipient of the System.Web.Services.Protocols.SoapHeader is the Web Service, the Web Service client or both.
A System.Web.Services.Protocols.SoapHeaderAttribute can be applied to either a Web Service method or a method on a proxy class to a Web Service. In either case, the recipient is specified by the System.Web.Services.Protocols.SoapHeaderAttribute.Direction property of System.Web.Services.Protocols.SoapHeaderAttribute.
ToString
Specifies the System.Web.Services.Protocols.SoapHeader is sent to the Web Service.
ToString
Specifies the System.Web.Services.Protocols.SoapHeader is sent to both the Web Service and the Web Service client.
ToString
Specifies the System.Web.Services.Protocols.SoapHeader is sent to the Web Service client.
SoapHeaderException class (System.Web.Services.Protocols)
ToString
Description
The exception that is thrown when a Web Service method is called over Simple Object Access Protocol (SOAP) and an exception occurs processing the SOAP header.
When a Web Service client adds a SOAP header to a Web Service method call with the System.Web.Services.Protocols.SoapHeader.MustUnderstand property set to true, the Web Service method must set the System.Web.Services.Protocols.SoapHeader.DidUnderstand property to true;otherwise a System.Web.Services.Protocols.SoapHeaderException is thrown.
SoapHeaderException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapHeaderException class. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property.
SoapHeaderException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapHeaderException class. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. A reference to the root cause of an exception. Sets the System.Exception.InnerException property.
SoapHeaderException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapHeaderException class. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property.
SoapHeaderException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapHeaderException class. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property. A reference to the root cause of an exception. Sets the System.Exception.InnerException property.
SoapHeaderException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapHeaderException class. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property. Optional exception information. Sets the System.Web.Services.Protocols.SoapException.OtherElements property.
SoapHeaderException
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapHeaderException class. A message that identifies the reason the exception occurred. Sets the System.Exception.Message property. The type of error that occurred. Sets the System.Web.Services.Protocols.SoapException.Code property. The piece of code that caused the exception. Typically, a URL to a Web Service method. Sets the System.Web.Services.Protocols.SoapException.Actor property. Optional exception information. Sets the System.Web.Services.Protocols.SoapException.OtherElements property. A reference to the root cause of an exception. Sets the System.Exception.InnerException property.
Actor
Code
Detail
HelpLink
HResult
InnerException
Message
OtherElements
Source
StackTrace
TargetSite
SoapHttpClientProtocol class (System.Web.Services.Protocols)
ToString
Description
Specifies the class ASP.NET Web Service client proxies derive from when using Simple Object Access Protocol (SOAP).
ASP.NET incorporates two distinct Web Services functionalities: Building ASP.NET Web Services and Building Web Services clients. If you are building a Web Service client using ASP.NET, then a proxy class deriving indirectly or directly from System.Web.Services.Protocols.WebClientProtocol needs to be created for the Web Service you want to call. When the Web Service client is calling via SOAP, the proxy class should derive from System.Web.Services.Protocols.SoapHttpClientProtocol, which derives from System.Web.Services.Protocols.HttpWebClientProtocol.
SoapHttpClientProtocol
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapHttpClientProtocol class.
AllowAutoRedirect
ClientCertificates
ConnectionGroupName
Container
CookieContainer
Credentials
DesignMode
Events
PreAuthenticate
Proxy
RequestEncoding
Site
Timeout
Url
UserAgent
BeginInvoke
Starts an asynchronous invocation of a Web Service method using Simple Object Access Protocol(SOAP).
Return Value: An System.IAsyncResult which is passed to System.Web.Services.Protocols.SoapHttpClientProtocol.EndInvoke(System.IAsyncResult) to obtain the return values from the remote method call.
Typically, you would not call the System.Web.Services.Protocols.SoapHttpClientProtocol.BeginInvoke(System.String,System.Object[ ] ,System.AsyncCallback,System.Object) method directly, unless you were building your own proxy class for a Web Service. The name of the Web Service method in the derived class that is invoking System.Web.Services.Protocols.SoapHttpClientProtocol.BeginInvoke(System.String,System.Object[ ] ,System.AsyncCallback,System.Object). An array of objects containing the parameters to pass to the remote web service. The order of the values in the array correspond to the order of the parameters in the calling method of the derived class. The delegate to call when the asynchronous invoke is complete. If callback is null, the delegate is not called. Extra information supplied by the caller.
Discover
Dynamically binds to a Web Service described in the discovery document at System.Web.Services.Protocols.WebClientProtocol.Url.
A Web Service client can dynamically bind to a Web Service other than the one referenced in the proxy class using the System.Web.Services.Protocols.SoapHttpClientProtocol.Discover method. Typically, the System.Web.Services.Protocols.WebClientProtocol.Url property refers to the base address of the Web Service, however prior to invoking the System.Web.Services.Protocols.SoapHttpClientProtocol.Discover method, set the System.Web.Services.Protocols.WebClientProtocol.Url property to a URL of a discovery document. Invoking the System.Web.Services.Protocols.SoapHttpClientProtocol.Discover method attempts to find a match in the discovery document to the binding defined in the proxy class and then dynamically bind to it. If successful, future method invocations are directed to the Web Service described in the discovery document.
EndInvoke
Ends an asynchronous invocation of a Web Service method using Simple Object Access Protocol(SOAP).
Return Value: An array of objects containing the return value and any by-reference or out parameters of the derived class method.
Typically, you would not call the System.Web.Services.Protocols.SoapHttpClientProtocol.EndInvoke(System.IAsyncResult) method directly, unless you were building your own proxy class for a Web Service. The System.IAsyncResult returned from System.Web.Services.Protocols.SoapHttpClientProtocol.BeginInvoke(System.String,System.Object[ ] ,System.AsyncCallback,System.Object).
GetWebRequest
Creates a System.Net.WebRequest instance for the specified url.
Return Value: The System.Net.WebRequest instance.
This method can be overridden to customize the System.Net.WebRequest object before the Web Service request is made. For example you could add a custom header to the request. The System.Uri to use when creating the System.Net.WebRequest.
Invoke
Invokes a Web Service method synchronously using SOAP.
Return Value: An array of objects containing the return value and any by reference or out parameters of the derived class method.
Typically, you would not call the System.Web.Services.Protocols.SoapHttpClientProtocol.Invoke(System.String,System.Object[ ]) method directly, unless you were building your own proxy class for a Web Service. The name of the Web Service method. An array of objects containing the parameters to pass to the remote web service. The order of the values in the array correspond to the order of the parameters in the calling method of the derived class.
SoapMessage class (System.Web.Services.Protocols)
ToString
Description
Represents the data in a SOAP request or SOAP response at a specific System.Web.Services.Protocols.SoapMessageStage.
The System.Web.Services.Protocols.SoapMessage class is primary used for SOAP extensions to represent the data in a SOAP request or SOAP response at the System.Web.Services.Protocols.SoapMessageStage in the System.Web.Services.Protocols.SoapMessage.Stage property. A SOAP extension, which is a class deriving from System.Web.Services.Protocols.SoapExtension, receives a System.Web.Services.Protocols.SoapMessage at each System.Web.Services.Protocols.SoapMessageStage when the System.Web.Services.Protocols.SoapExtension.ProcessMessage(System.Web.Services.Protocols.SoapMessage) method is called. It is up to the particular SOAP extension to decide how to process the System.Web.Services.Protocols.SoapMessage, but a couple of common SOAP extensions might include encryption and compression.
Action
ToString
When overridden in a derived class, gets the SOAPAction HTTP request header field for the SOAP request or SOAP response.
The System.Web.Services.Protocols.SoapMessage.Action property can be accessed during any System.Web.Services.Protocols.SoapMessageStage.
ContentType
ToString
Gets or sets the HTTP Content-Type of the SOAP request or SOAP response.
The System.Web.Services.Protocols.SoapMessage.ContentType property can only be accessed in the System.Web.Services.Protocols.SoapMessageStage.BeforeSerialize and System.Web.Services.Protocols.SoapMessageStage.BeforeDeserialize stages; otherwise an System.InvalidOperationException is thrown.
Exception
ToString
Gets the System.Web.Services.Protocols.SoapException from the call to the Web Service method.
The System.Web.Services.Protocols.SoapMessage.Exception property can be accessed during any System.Web.Services.Protocols.SoapMessageStage
Headers
ToString
A collection of the SOAP headers applied to the current SOAP request or SOAP response.
SOAP headers are an optional portion of a SOAP request or SOAP response. For more details on using SOAP headers in ASP.NET Web Services and ASP.NET clients, see the System.Web.Services.Protocols.SoapHeader class.
MethodInfo
ToString
When overridden in a derived class, gets a representation of the method prototype for the Web Service method for which the SOAP request is intended.
Although the System.Web.Services.Protocols.SoapMessage.MethodInfo can be accessed during any System.Web.Services.Protocols.SoapMessageStage, it only has data during System.Web.Services.Protocols.SoapMessageStage.AfterDeserialize and System.Web.Services.Protocols.SoapMessageStage.BeforeSerialize.
OneWay
ToString
Gets a value indicating the System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay property of either the System.Web.Services.Protocols.SoapDocumentMethodAttribute or System.Web.Services.Protocols.SoapRpcMethodAttribute applied to the Web Service method.
See the System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay property of System.Web.Services.Protocols.SoapDocumentMethodAttribute or System.Web.Services.Protocols.SoapRpcMethodAttribute for details about one-way Web Service methods.
Stage
ToString
Gets the System.Web.Services.Protocols.SoapMessageStage of the System.Web.Services.Protocols.SoapMessage.
The System.Web.Services.Protocols.SoapMessage.Stage property can be accessed at any System.Web.Services.Protocols.SoapMessageStage.
Stream
ToString
Gets the data representing the SOAP request or SOAP response in the form of a System.IO.Stream object.
SOAP extensions that inspect the data representing a SOAP request or SOAP response, such as a logging SOAP extension, can use the System.IO.Stream property to view the data at each System.Web.Services.Protocols.SoapMessageStage.
Url
ToString
When overridden in a derived class, gets the base URL of the Web Service.
The System.Web.Services.Protocols.SoapMessage.Url property can be accessed during any System.Web.Services.Protocols.SoapMessageStage.
EnsureInStage
When overridden in a derived class, asserts that the current System.Web.Services.Protocols.SoapMessageStage stage is a stage where in parameters are available.
The asserted stage is different for Web Service clients and Web Service methods. A Web Service method's in parameters are available after the SOAP request is deserialized in the System.Web.Services.Protocols.SoapMessageStage.AfterDeserialize stage. For a Web Service client, the in parameters are available prior to the SOAP request serialization process in the System.Web.Services.Protocols.SoapMessageStage.BeforeSerialize stage.
EnsureOutStage
When overridden in a derived class, asserts that the current System.Web.Services.Protocols.SoapMessageStage stage is a stage where out parameters are available.
The asserted stage is different for Web Service clients and Web Service methods. A Web Service method's out parameters are available prior to the SOAP response serialization process in the System.Web.Services.Protocols.SoapMessageStage.BeforeSerialize stage. For a Web Service client, the out parameters are available after the SOAP response deserialization process in the System.Web.Services.Protocols.SoapMessageStage.AfterDeserialize stage.
EnsureStage
Ensures that the System.Web.Services.Protocols.SoapMessageStage of the call to the Web Service method is the stage or stages passed in. If the current processing stage is not one of the stages passed in, an exception is thrown.
Multiple stages can be asserted by performing a bitwise OR operation on multiple System.Web.Services.Protocols.SoapMessageStage stages. The System.Web.Services.Protocols.SoapMessageStage asserted.
GetInParameterValue
Gets the parameter passed into the Web Service method at the specified index.
Return Value: An System.Object representing the parameter at index in the array of parameters.
The System.Web.Services.Protocols.SoapMessage.GetInParameterValue(System.I nt32) property is only accessible when in parameters are available. ASP.NET Web Services throws System.InvalidOperationException when accessing the System.Web.Services.Protocols.SoapMessage.GetInParameterValue(System.I nt32) property if in parameters are not available. The zero-based index of the parameter in the array of parameters.
GetOutParameterValue
Gets the out parameter passed into the Web Service method at the specified index.
Return Value: An System.Object representing the parameter at index in the array of parameters.
The System.Web.Services.Protocols.SoapMessage.GetInParameterValue(System.Int32) property is only accessible when out parameters are available. ASP.NET Web Services throws System.InvalidOperationException when accessing the System.Web.Services.Protocols.SoapMessage.GetOutParameterValue(System.Int32) property if out parameters are not available. The zero-based index of the parameter in the array of parameters.
GetReturnValue
Gets the return value of a Web Service method.
Return Value: An System.Object representing the return value of the Web Service method.
The System.Web.Services.Protocols.SoapMessage.GetReturnValue property is only accessible when a return value is available. ASP.NET Web Services throws System.InvalidOperationException when accessing the System.Web.Services.Protocols.SoapMessage.GetReturnValue property and the return value is not available.
SoapMessageStage enumeration (System.Web.Services.Protocols)
ToString
Description
Specifies the processing stage of a SOAP message.
ASP.NET Web Services provides an extensibility mechanism for calling Web Services using SOAP. The extensibility mechanism revolves around a System.Web.Services.Protocols.SoapExtension that is allowed to inspect or modify a message at specific stages in message processing on either the client or the server. This enum specifies the processing stage of a System.Web.Services.Protocols.SoapMessage.
ToString
The stage just after a System.Web.Services.Protocols.SoapMessage is deserialized from a SOAP message into a object.
ToString
The stage just after a System.Web.Services.Protocols.SoapMessage is serialized, but before the SOAP message is sent over the wire.
ToString
The stage just before a System.Web.Services.Protocols.SoapMessage is deserialized from the SOAP message sent across the network into a object.
ToString
The stage just prior to a System.Web.Services.Protocols.SoapMessage being serialized.
SoapParameterStyle enumeration (System.Web.Services.Protocols)
ToString
Description
Specifies how parameters are encoded in the XML portion of a SOAP message.
System.Web.Services.Protocols.SoapParameterStyle can be set when applying a System.Web.Services.Protocols.SoapDocumentMethodAttribute or System.Web.Services.Protocols.SoapDocumentServiceAttribute attribute to a Web Service method or a method of a client proxy class and the class implementing a Web Service respectively.
ToString
Specifies the Web Service method parameters are elements directly beneath the Body element of the XML portion of a SOAP request or SOAP response.
ToString
Specifies using the default SoapParameterStyle for the Web Service. The default can for a Web Service by applying a SoapDocumentServiceAttribute to the class implementing the Web Service. If a System.Web.Services.Protocols.SoapDocumentServiceAttribute is not applied to the class implementing the Web Service the default is System.Web.Services.Protocols.SoapParameterStyle.Wrapped.
ToString
Specifies the Web Service method parameters are wrapped within a single element beneath the Body element of the XML portion of a SOAP request or SOAP response.
SoapRpcMethodAttribute class (System.Web.Services.Protocols)
ToString
Description
Applying the optional System.Web.Services.Protocols.SoapRpcMethodAttribute to a Web Service method alters the format of the SOAP request or response sent to and from a Web Service method.
Web Services Description Language (WSDL) defines two styles for how a Web Service method, which it calls an operation, can be encoded in a SOAP request or a SOAP response: RPC and Document. The RPC style refers to encoding the Web Service method according to the SOAP specification for using SOAP for RPC; otherwise known as Section 7 of the SOAP specification. This style states that all parameters are wrapped within a single element named after the Web Service method and that each element within that element represent a parameter named after their respective parameter name.
SoapRpcMethodAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapRpcMethodAttribute class setting all properties to their defaults.
SoapRpcMethodAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapRpcMethodAttribute class setting the System.Web.Services.Protocols.SoapRpcMethodAttribute.Action property to action. The intent of the SOAP request. Sets the System.Web.Services.Protocols.SoapRpcMethodAttribute.Action property.
Action
ToString
Gets or sets the intent of the SOAP request.
The System.Web.Services.Protocols.SoapRpcMethodAttribute.Action property forms the SOAPAction HTTP Header Field for the HTTP Request.
Binding
ToString
Gets or sets the binding a Web Service method is implementing a operation for.
A binding, as defined by Web Services Description Language(WSDL), is similar to an interface, in that it defines a concrete set of operations. With respect to ASP.NET Web Services, each Web Service method is an operation within a binding. Web Service methods are members of either the default binding for a Web Service or in a binding specified within a System.Web.Services.WebServiceBindingAttribute applied to a Web Service. A Web Service can implement multiple bindings, by applying multiple System.Web.Services.WebServiceBindingAttribute attributes to a Web Service.
OneWay
ToString
Gets or sets whether a Web Service client waits for the Web server to finish processing a Web Service method.
When a Web Service method sets the System.Web.Services.Protocols.SoapRpcMethodAttribute.OneWay property to true, the Web Service client does not have to wait for the Web server to finish processing the Web Service method. As soon as the Web server has deserialized the System.Web.Services.Protocols.SoapServerMessage, but before invoking the Web Service method, the server returns an HTTP 202 status code. A HTTP 202 status code indicates to the client that the Web server has started processing of the message. Therefore, a Web Service client receives no acknowledgment that the Web server successfully processed the message.
RequestElementName
ToString
Gets or sets the XML element associated with the SOAP request for a Web Service method.
The System.Web.Services.Protocols.SoapRpcMethodAttribute.RequestElementName defines the XML element used to wrap the parameters beneath the Body element of the SOAP request.
RequestNamespace
ToString
Gets or sets the XML namespace associated with the SOAP request for a Web Service method.
ResponseElementName
ToString
Gets or sets the XML element associated with the SOAP response for a Web Service method.
The System.Web.Services.Protocols.SoapRpcMethodAttribute.ResponseElement Name defines the XML element used to wrap the parameters beneath the Body element of the SOAP response.
ResponseNamespace
ToString
Gets or sets the XML namespace associated with the SOAP response for a Web Service method.
The System.Web.Services.Protocols.SoapRpcMethodAttribute.ResponseNamespace property is used in the XSD schema for the Web Service method in its Service Description.
TypeId
SoapRpcServiceAttribute class (System.Web.Services.Protocols)
ToString
Description
Applying the optional System.Web.Services.Protocols.SoapRpcServiceAttribute to a Web Service sets the default format of SOAP requests and responses sent to and from Web Service methods within the Web Service.
The System.Web.Services.Protocols.SoapRpcServiceAttribute allows you to set the default encoding styles for Web Service methods within a Web Service to use RPC method encoding and System.Web.Services.Description.SoapBindingUse.Encoded parameter encoding.
SoapRpcServiceAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.SoapRpcServiceAttribute class.
RoutingStyle
ToString
TypeId
SoapServerMessage class (System.Web.Services.Protocols)
ToString
Description
Represents the data in a SOAP request received or a SOAP response sent by a Web Service method at a specific System.Web.Services.Protocols.SoapMessageStage.
Action
ToString
Gets the SOAPAction HTTP request header field for the SOAP request or SOAP response.
The System.Web.Services.Protocols.SoapServerMessage.Action property can be accessed during any System.Web.Services.Protocols.SoapMessageStage.
ContentType
Exception
Headers
MethodInfo
ToString
Description
Gets a representation of the method prototype for the Web Service method for which the SOAP request is intended.
Although the System.Web.Services.Protocols.SoapServerMessage.MethodInfo property can be accessed during any stage, the method information is only available during System.Web.Services.Protocols.SoapMessageStage.AfterDeserialize and System.Web.Services.Protocols.SoapMessageStage.BeforeSerialize.
OneWay
ToString
Gets a value indicating whether the client waits for the server to finish processing a Web Service method.
A System.Web.Services.Protocols.SoapDocumentMethodAttribute or System.Web.Services.Protocols.SoapRpcMethodAttribute applied to a Web Service method or Web Service client can specify whether the Web Service method is one way or not by setting the System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay property of the attribute.
Server
ToString
Gets the instance of the class handling the method invocation on the Web server System.Web.Services.Protocols.SoapMessageStage is not System.Web.Services.Protocols.SoapMessageStage.AfterDeserialize or System.Web.Services.Protocols.SoapMessageStage.BeforeSerialize.
The System.Web.Services.Protocols.SoapServerMessage.Server property is an instance of the class implementing the Web Service. If a SOAP extension knew ahead of time the type of the class, it could cast System.Web.Services.Protocols.SoapServerMessage.Server to that type and access properties and methods of the class implementing the Web Service.
Stage
Stream
Url
ToString
Description
Gets the base url of the Web Service.
The System.Web.Services.Protocols.SoapServerMessage.Url property can be accessed during any System.Web.Services.Protocols.SoapMessageStage
EnsureInStage
Asserts that the current System.Web.Services.Protocols.SoapMessageStage stage is a stage where in parameters are available. If not, an exception is thrown. For Web Service methods, the in parameters are available after the SOAP request in the deserialization process in the System.Web.Services.Protocols.SoapMessageStage.AfterDeserialize stage. The System.InvalidOperationException is thrown if System.Web.Services.Protocols.SoapServerMessage.EnsureInStage method is invoked in any other System.Web.Services.Protocols.SoapMessageStage.
EnsureOutStage
Asserts that the current System.Web.Services.Protocols.SoapMessageStage stage is a stage where out parameters are available. If not, an exception is thrown.
For Web Service methods, the out parameters are available prior to the SOAP response serialization process in the System.Web.Services.Protocols.SoapMessageStage.BeforeSerialize stage. The System.InvalidOperationException is thrown if System.Web.Services.Protocols.SoapServerMessage.EnsureOutStage method is invoked in any other System.Web.Services.Protocols.SoapMessageStage.
SoapServiceRoutingStyle enumeration (System.Web.Services.Protocols)
ToString
ToString
ToString
SoapUnknownHeader class (System.Web.Services.Protocols)
ToString
Description
Represents the data received from a SOAP header that was not understood by the recipient Web Service or Web Service client. This class cannot be inherited.
A SOAP client may invoke a Web Service with additional data beyond just the required parameters in the form of a SOAP header. An ASP.NET Web Service or Web Service client can view any SOAP headers it did not know about at the time the Web Service was written by applying a System.Web.Services.Protocols.SoapHeaderAttribute with a System.Web.Services.Protocols.SoapHeaderAttribute.MemberName property of either an array of System.Web.Services.Protocols.SoapHeader, System.Web.Services.Protocols.SoapHeader, System.Web.Services.Protocols.SoapUnknownHeader or an array of System.Web.Services.Protocols.SoapUnknownHeader to the Web Service method. Specifiying a System.Type of System.Web.Services.Protocols.SoapUnknownHeader, allows the Web Service to view the contents of the SOAP header and attempt to understand the semantics of the SOAP header, in the form of an System.Xml.XmlElement.
SoapUnknownHeader
Example Syntax:
ToString
Actor
DidUnderstand
Element
ToString
Description
Gets or sets the XML Header element for a SOAP request or response.
If a Web Service method wants to process SOAP headers it doesn't know about at the time the Web Service is written, a Web Service method can process an System.Xml.XmlElement class representing the raw XML of the SOAP header.
EncodedMustUnderstand
MustUnderstand
TextReturnReader class (System.Web.Services.Protocols)
ToString
Description
TextReturnReader
Example Syntax:
ToString
GetInitializer
Initialize
Read
UrlEncodedParameterWriter class (System.Web.Services.Protocols)
ToString
Description
UrlEncodedParameterWriter
Example Syntax:
ToString
RequestEncoding
ToString
UsesWriteRequest
Encode
Encode
GetInitializer
Initialize
UrlParameterReader class (System.Web.Services.Protocols)
WriteRequest
Description
UrlParameterReader
Example Syntax:
WriteRequest
Read
UrlParameterWriter class (System.Web.Services.Protocols)
ToString
Description
UrlParameterWriter
Example Syntax:
ToString
RequestEncoding
UsesWriteRequest
GetRequestUrl
ValueCollectionParameterReader class (System.Web.Services.Protocols)
WriteRequest
Description
ValueCollectionParameterReader
Example Syntax:
WriteRequest
GetInitializer
Initialize
IsSupported
IsSupported
Read
WebClientAsyncResult class (System.Web.Services.Protocols)
ToString
Description
AsyncState
ToString
AsyncWaitHandle
ToString
CompletedSynchronously
ToString
Gets a value indicating whether the invocation of the Web Service method completed synchronously.
IsCompleted
ToString
Gets a value indicating whether the asynchronous request has completed.
Abort
WebClientProtocol class (System.Web.Services.Protocols)
ToString
Description
Specifies the base class for all ASP.NET Web Service client proxies.
ASP.NET incorporates two distinct functionalities of Web Services: building ASP.NET Web Services and building Web Service clients. If you are building a Web Service client using ASP.NET, you must create a proxy class deriving indirectly or directly from System.Web.Services.Protocols.WebClientProtocol for the Web Service you want to call.
WebClientProtocol
Example Syntax:
ToString
Initializes a new instance of the System.Web.Services.Protocols.WebClientProtocol class.
ConnectionGroupName
ToString
Gets or sets the name of the connection group for the request.
The System.Web.Services.Protocols.WebClientProtocol.ConnectionGroupName property enables you to associate a request to a connection group. For more details, see System.Net.HttpWebRequest.ConnectionGroupName.
Container
Credentials
ToString
Description
Gets or sets security credentials for Web Service client authentication.
When using the Credentials property, a Web Service client must instantiate a class implementing System.Net.ICredentials, such as System.Net.NetworkCredential, and then set the client credentials specific to the authentication mechanism. The System.Net.NetworkCredential class can be used to set authentication credentials using the basic, digest, NTLM and Kerberos authentication mechanisms.
DesignMode
Events
PreAuthenticate
ToString
Description
Gets or sets whether pre-authentication is enabled.
When System.Web.Services.Protocols.WebClientProtocol.PreAuthenticate is true, the WWW-authenticate header is sent with each request back to the server, otherwise standard authentication procedures are used. When System.Web.Services.Protocols.WebClientProtocol.PreAuthenticate is false, the authentication headers are sent only on the first request.
RequestEncoding
ToString
The System.Text.Encoding used to make the client request to the Web Service.
The System.Web.Services.Protocols.WebClientProtocol.RequestEncoding determines the encoding for the request message. The System.Net.WebRequest.ContentType of the request will be annotated with the encoding value.
Site
Timeout
ToString
Description
Indicates the time a Web Service client waits for a synchronous Web Service request to complete (in milliseconds).
Even though a Web Service client can set the System.Web.Services.Protocols.WebClientProtocol.Timeout property to infinity with a value of −1, the Web Server can still cause the request to time out on the server side.
Url
ToString
Gets or sets the base URL of the Web Service the client is requesting.
Proxy classes generated using Wsdl.exe will set a default System.Web.Services.Protocols.WebClientProtocol.Url property for the client to use. The default System.Web.Services.Protocols.WebClientProtocol.Url is determined by the location attribute found in the Service Description from which the proxy class was generated.
Abort
Cancels a request to a Internet resource.
Return Value: System.Web.Services.Protocols.WebClientProtocol.Abort cancels a reqeust to a resource made using the System.Web.Services.Protocols.WebClientProtocol.GetWebRequest(System.Uri) method. After the request is canceled, invoking System.Web.Services.Protocols.WebClientProtocol.GetWebResponse(System.Net.WebRequest) will cause a System.Net.WebException.
AddToCache
Add an instance of the client protocol handler to the cache.
GetFromCache
Gets an instance of a client protocol handler from the cache.
GetWebRequest
Creates a System.Net.WebRequest instance for the specified url.
Return Value: The System.Net.WebRequest instance.
This method can be overridden to customize the System.Net.WebRequest object before the Web Service request is made. For example you could add a custom header to the request. The System.Uri to use when creating the System.Net.WebRequest.
GetWebResponse
Returns a response from a synchronous request to a Web Service method.
Return Value: A System.Net.WebResponse. The System.Net.WebRequest to get the response from.
GetWebResponse
Returns a response from an asynchronous request to a Web Service method.
Return Value: The System.Net.WebResponse instance. The System.Net.WebRequest to get the response from. The System.IAsyncResult to pass to System.Net.HttpWebRequest.EndGetResponse(System.IAsyncResult). when the response has completed.
WebServiceHandlerFactory class (System.Web.Services.Protocols)
ToString
Description
WebServiceHandlerFactory
Example Syntax:
ToString
GetHandler
ReleaseHandler
XmlReturnReader class (System.Web.Services.Protocols)
ToString
Description
XmlReturnReader
Example Syntax:
ToString
GetInitializer
GetInitializers
Initialize
Read
HttpSessionState class (System.Web.SessionState)
Description
Provides access to session state values as well as session-level settings and lifetime management methods.
Properties:
CodePage
Gets or sets the code page identifier for the current session.
Contents
Gets a reference to the current session state object.
Contents is provided for legacy ASP compatibility.
Count
Gets the number of items in the session state collection.
IsCookieless
Gets a value indicating whether the session is managed using cookieless session.
IsNewSession
Gets a value indicating whether the session has been created with the current request.
IsReadOnly
Gets a value indicating whether the session is read-only.
IsSynchronized
Gets a value indicating whether access to the collection of session state values is read-only (thread-safe).
Item
Gets or sets a session value by name. The key name of the session value.
Item
Gets or sets a session value by numerical index. The numerical index of the session value.
Keys
Gets a collection of all session keys.
LCID
Gets or sets the locale identifier (LCID) of the current session.
Mode
Gets the current session state mode.
SessionID
Gets the unique session ID used to identify a session.
StaticObjects
Gets a collection of objects declared by
System.Web.UI
Description
The System.Web.UI namespace provides classes and interfaces that allow you to create controls and pages that will appear in your Web applications as user interface on a Web page. This namespace includes the Control class, which provides all controls, whether HTML, Web, or User controls, with a common set of functionality. It also includes the Page control, which is generated automatically whenever a request is made for a page in your Web application. Also provided are classes which provide the Web Forms Server Controls data binding functionality, the ability to save the view state of a given control or page, as well as parsing functionality for both programmable and literal controls.
AttributeCollection class (System.Web.UI)
Description
Provides object-model access to all attributes declared in the opening tag of an ASP.NET server control element. This class cannot be inherited.
Attributes are case-insensitive strings. They return a System.String object as their value. If there are no attributes in the collection, they return null.
Constructors:
AttributeCollection
Example Syntax:
Initializes a new instance of the System.Web.UI.AttributeCollection class. A System.Web.UI.StateBag object that contains the attribute keys and their values that are in the opening tag of the server control.
Properties:
Count
Gets the number of attributes in the System.Web.UI.AttributeCollection object.
CssStyle
Gets a collection of styles for the ASP.NET server control to which the current System.Web.UI.AttributeCollection object belongs.
Any style declared for a particular HTML server control is added to the CssStyleCollection object when the containing Web Forms page is parsed. You can use this property to add, remove and iterate through the styles declared for the server control.
Item
Gets or sets a specified attribute value for a server control. The location of the attribute within the collection.
Keys
Gets a collection of keys to all attributes in the server control's System.Web.UI.AttributeCollection object.
Methods:
Add
Adds an attribute to a server contol's System.Web.UI.AttributeCollection object. The index assigned to the new attribute in the collection. The attribute to store in the collection.
AddAttributes
Adds attributes from the AttributeCollection class to the System.Web.UI.HtmlTextWriter object that is responsible for rendering the attributes as HTML to an ASP.NET server control.
This method copies all of the server control's attributes to an System.Web.UI.HtmlTextWriter object so they can be rendered by the next call to the System.Web.UI.HtmlTextWriter.RenderBeginTag(System.String) method. An System.Web.UI.HtmlTextWriter that writes the added attribute to the opening tag of an ASP.NET server control.
Clear
Removes all attributes from a server control's System.Web.UI.AttributeCollection object.
Remove
Render
Writes the collection of attributes to the specified System.Web.UI.HtmlTextWriter output stream. In turn, the output stream writes the collection to the Web Forms page. An System.Web.UI.HtmlTextWriter object that writes the attribute collection to the opening HTML tag.
AutomaticHandlerMethodInfos class (System.Web.UI)
ToString
Description
AutomaticHandlerMethodInfos
Example Syntax:
ToString
BaseParser class (System.Web.UI)
ToString
Description
Provides a base set of functionality for all parsers involved in parsing ASP.NET page requests. This includes parsing of all ASP.NET server controls, including pages and user controls.
BaseParser
Example Syntax:
ToString
BasePartialCachingControl class (System.Web.UI)
ToString
Description
Provides a base set of functionality for the System.Web.UI.StaticPartialCachingControl and the System.Web.UI.PartialCachingControl classes.
BasePartialCachingControl
Example Syntax:
ToString
ChildControlsCreated
ClientID
Context
Controls
Dependency
ToString
Description
Gets or sets an instance of the System.Web.Caching.CacheDependency class associated with the cached server control output.
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Dispose
OnInit
Raises the Init event for the server control to be output cached.
This method checks the cache for the content associated with the server control. If it is not there, the server control is created and added to the parent control's System.Web.UI.ControlCollection object. An System.EventArgs object that contains the event data.
Render
Outputs the server control's content to the System.Web.UI.HtmlTextWriter output stream. The System.Web.UI.HtmlTextWriter object that writes the cached control to the page.
BuildMethod delegate (System.Web.UI)
TrackViewState
Description
Represents the method that is used to build a System.Web.UI.Control.
This delegate passes the information necessary to build ASP.NET server controls as defined by the TemplateControl class, or one of the classes that inherit from TemplateControl, Page and UserControl.
BuildTemplateMethod delegate (System.Web.UI)
TrackViewState
Description
CompiledTemplateBuilder class (System.Web.UI)
TrackViewState
Description
CompiledTemplateBuilder
Example Syntax:
TrackViewState
InstantiateIn
ConstructorNeedsTagAttribute class (System.Web.UI)
ToString
Description
Specifies that a server control needs a tag name in its constructor.
ConstructorNeedsTagAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.ConstructorNeedsTagAttribute class.
ConstructorNeedsTagAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.ConstructorNeedsTagAttribute class. true to add a tag to a control; otherwise, false.
NeedsTag
ToString
Indicates whether a control needs a tag in its contstructor. This property is read-only.
TypeId
Control class (System.Web.UI)
ToString
Description
Defines the properties, methods, and events that are shared by all ASP.NET server controls.
This is the primary class that you derive from when you develop custom ASP.NET server controls.
Control
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Control class.
ChildControlsCreated
ToString
Gets a value that indicates whether the server control's child controls have been created.
ClientID
ToString
Gets the server control identifier generated by ASP.NET.
ASP.NET automatically generates a ClientID for a server control regardless of whether you have specified an ID property for it or not. A ClilentID is assigned to all System.Web.UI.LiteralControl objects (text and HTML that is not processed on the server) on a page when it is requested. You can view the ClientID s of each control in a page's control hierarchy by enabling tracing for the page or application. The format for automatically generated ClientID s is Ctrl0 for the first control on a page, Ctrl1 for the next control, Ctrl2 for the third control, and so on until all controls for the page are given a ClientID value.
Context
ToString
Gets the System.Web.HttpContext object associated with the server control for the current Web request.
This property gives you access to the Context object for the current Web request. The object provides properties that access the Application, Session, Request, Response, and other objects that contain information about the current HTTP request. It also provides methods that allow you to obtain configuration information and set or clear errors for the request.
Controls
ToString
Gets a System.Web.UI.ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
On an ASP.NET page, when controls are added declaratively between the opening and closing tags of a server control, ASP.NET automatically adds the controls to the containing server control's System.Web.UI.ControlCollection. Any HTML tags or text strings that are not processed on the server are compiled into System.Web.UI.LiteralControl objects. These are added to the collection like other server controls.
EnableViewState
ToString
Gets or sets a value indicating whether the server control maintains its view state, and the view state of any child controls it contains, when the current page request ends.
You must enable view state for the server control to maintain its state across HTTP requests.
Events
ToString
Gets a list of event handler delegates for the control. This property is read-only.
This property is of type System.ComponentModel.EventHandlerList, which uses a linear search algorithm to find entries in the list of delegates. A linear search algorithm is inefficient when working with a large number of entries. Therefore, when you have a large list, finding entries with this property will be slow.
HasChildViewState
ToString
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
You can avoid unnecessary calls to the System.Web.UI.Control.ClearChildViewState method by using this property to verify that any child controls of the server control are storing view-state information.
ID
ToString
Gets or sets the programmatic identifier assigned to the server control.
Setting this property on a server control provides you with programmatic access to the server control's properties, events, and methods. This property can be set by Web developers by declaring an id attribute in the opening tag of an ASP.NET server control.
IsTrackingViewState
ToString
Gets a value that indicates whether the server control is saving changes to its view state.
For a sample custom server control that uses this property, see.
NamingContainer
ToString
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same System.Web.UI.Control.ID property value.
Each page in an ASP.NET Web application contains a hierarchy of controls. This hierarchy is not dependent on whether a control generates UI visible to the user. The naming container for a given control is the parent control above it in the hierarchy that implements the INamingContainer interface. A server control that implements this interface creates a unique namespace for the ID property values of its child server controls.
Page
ToString
Gets a reference to the System.Web.UI.Page instance that contains the server control.
This property reflects the name of the .aspx file associated with the current Web request. In the control hierarchy, name of the page is _PAGE by default. It is assigned to a type defined by the name of the .aspx file.
Parent
ToString
Gets a reference to the server control's parent control in the page UI hierarchy.
Whenever a page is requested, a hierarchy of server controls on that page is built. This property allows you to determine the parent control of the current server control in that hierarchy, and to program against it.
Site
ToString
Gets information about the Web site to which the server control belongs.
Sites bind a Component to a Container and enable communication between them. They also provide a way for the container to manage its components.
TemplateSourceDirectory
ToString
Gets the virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl that contains the current server control.
UniqueID
ToString
Gets the unique, hierarchically-qualified identifier for the server control.
This property differs from the ID property, in that the UniqueID property includes the identifier for the server control's naming container. This identifier is generated automatically when a page request is processed.
ViewState
ToString
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
A server control's view state is the accumulation of all its property values. In order to preserve these values across HTTP requests, ASP.NET server controls use this property, which is an instance of the StateBag class, to store the property values. The values are then passed as a variable to a hidden field when subsequent requests are processed. For more information about view state, see. For more information about saving server control view state, see.
ViewStateIgnoresCase
ToString
Gets a value that indicates whether the System.Web.UI.StateBag object is case-insensitive.
Visible
ToString
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
Server controls that are not visible take up no space on a Web Forms page when it is displayed.
ToString
Occurs when the server control binds to a data source.
This event notifies the server control to perform any data binding logic that has been written for it.
ToString
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
Resources that require significant processor time, such as database connections, should be released with this event.
ToString
Occurs when the server control is initialized, which is the first step in the its lifecycle.
Server controls should perform any initialization steps that are required to create and set up an instance. You cannot use view-state information within this event; it is not populated yet. You should not access another server control during this event, regardless of whether it is a child or parent to this control. Other server controls are not certain to be created and ready for access.
ToString
Occurs when the server control is loaded into the System.Web.UI.Page object.
Notifies the server control to perform any processing steps that are set to occur on each page request. You can use view state information with this event. You can also access other server controls within the page's control hierarchy.
ToString
Occurs when the server control is about to render to its containing System.Web.UI.Page object.
Use this event to perform any updates before the output the server control is rendered to the page. Any changes in the view state of the server control can be saved during this event. Such changes made in the rendering phase will not be saved.
ToString
Occurs when the server control is unloaded from memory.
Server controls must perform any final clean-up, such as closing files, database connections and discarding objects, during this stage of the control lifecycle before the instance is unloaded.
AddedControl
AddParsedSubObject
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's System.Web.UI.ControlCollection object.
Unless you override it, this method automatically adds System.Web.UI.LiteralControl objects to the server control's ControlCollection object. This collection is accessible through System.Web.UI.Control.Controls property. An System.Object that represents the parsed element.
BuildProfileTree
Gathers information about the server control and delivers it to the System.Web.UI.Page.Trace property to be displayed when tracing is enabled for the page.
This property gathers the information necessary about a page's UI hierarchy and passes it to the page's Trace property. When you enable tracing, either for a page or for your application, this information is displayed in the Control Tree section of the trace output. Trace output for a page is appended to the end of the page; while trace output for an application can be viewed from the trace viewer (trace.axd file) which is stored in the application's root directory. For more information about tracing, see. The identifier of the control's parent. A Boolean that indicates whether the view-state size is calculated.
ClearChildViewState
Deletes the view-state information for all of the server control's child controls.
This method is commonly used when you override the System.Web.UI.Control.DataBind method when developing templated data-bound server controls. If you do not call this method, child control view-state information can be written to a parent server control, only to be overridden when data binding occurs.
CreateChildControls
Notifies server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
When you develop a composite or templated server control, you must override this method. For more information, see and.
CreateControlCollection
Creates a new System.Web.UI.ControlCollection object to hold the child controls (both literal and server) of the server control.
Return Value: A ControlCollection object that contains the current server control's child server controls.
DataBind
Binds a data source to the invoked server control and all of its child controls.
Use this method to bind data from a source to a server control. This method is commonly used after retrieving a data set through a database query.
Dispose
Enables a server control to perform final clean up before it is released from memory.
Call Dispose when you are finished using the System.Web.UI.Control. The Dispose method leaves the Control in an unusable state. After calling this method, you must release all references to the control so the memory it was occupying can be reclaimed by garbage collection.
EnsureChildControls
Checks if the server control contains child controls. If it does not, it creates child controls.
If the server control contains nothing but literal content or HTML that is parsed and compiled as a System.Web.UI.LiteralControl object, it adds that object to the server control's System.Web.UI.ControlCollection object. The instance of the LiteralControl then becomes a child of the server control.
FindControl
Searches the current naming container for a server control with the specified id parameter.
Return Value: The specified control, or 0 if the specified control does not exist. The identifier for the control to be found.
FindControl
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, that aids in the search.
Return Value: The specified control, or 0 if the specified control does not exist. The identifier for the control to be found. The number of controls up the page control hierarchy needed to reach a naming container.
HasControls
Determines if the server control contains any child controls.
Return Value: true if the control contains other controls; otherwise, false.
Since this method simply determines if any child controls exist, it can enhance performance by allowing you to avoid an unnecessary call to the Count property on the server control's System.Web.UI.ControlCollection object. The ControlCollection is available on the control through the System.Web.UI.Control.Controls property.
IsLiteralContent
Determines if the server control holds only literal content.
Return Value: true if the server control is comprised of literal content; otherwise false.
When this method returns true, the server control's collection holds a single literal control. The content is then passed to the requesting browser as HTML.
LoadViewState
Restores view-state information from a previous page request that was saved by the System.Web.UI.Control.SaveViewState method.
Override this method when you need to customize how a custom server control restores its view state. For more information, see. An System.Object that represents the control state to be restored.
MapPathSecure
Retrieves a mapped physical file path relative to the source file, if the requesting server control has sufficient security permissions to read the mapped result.
Return Value: The physical path to the requested file.
This method can only be used by server controls that have permissions to read files and which are part of fully trusted .dll files, such as System.Web.dll. This helps prevent security breaches. A relative or root relative URL.
OnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
Return Value: true if the event has been cancelled; otherwise, false. The default is false.
ASP.NET server controls such as the System.Web.UI.WebControls.Repeater, System.Web.UI.WebControls.DataList and System.Web.UI.WebControls.DataGrid Web controls can contain child controls that raise events. For example, each row in a DataGrid control can contain one or more buttons created dynamically by templates. The source of the event. An System.EventArgs object that contains the event data.
OnDataBinding
Raises the DataBinding event.
This method notifies a server control to perform any data binding logic that is associated with it. An EventArgs object that contains the event data.
OnInit
Raises the Init event.
When notified by this method, server controls must perform any initialization steps that are required to create and set up an instance. In this stage of the server control's lifecycle, the control's view state has yet to be populated. Additionally, you can not access other server controls when this method is called either, regardless of whether it is a child or parent to this control. Other server controls are not certain to be created and ready for access. An System.EventArgs object that contains the event data.
OnLoad
Raises the Load event.
This method notifies the server control that it should perform actions common to each HTTP request for the page it is associated with, such as setting up a database query. At this stage in the page lifecycle, server controls in the hierarchy are created and initialized, view state is restored, and form controls reflect client-side data. The System.EventArgs object that contains the event data.
OnPreRender
Raises the System.Web.UI.Control.PreRender event, which notifies the server control that
This method notifies the server control to perform any necessary prerendering steps prior to saving view state and rendering content. An System.EventArgs object that contains the event data.
OnUnload
Raises the Unload event. An System.EventArgs object that contains event data.
RaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
ASP.NET server controls such as the System.Web.UI.WebControls.Repeater, System.Web.UI.WebControls.DataList and System.Web.UI.WebControls.DataGrid Web controls can contain child controls that raise events. For example, each row in a DataGrid control can contain one or more buttons created dynamically by templates. The source of the event. An System.EventArgs object that contains the event data.
RemovedControl
Render
Sends server control content to a provided System.Web.UI.HtmlTextWriter object, which writes the content to be rendered on the client.
When developing custom server controls, you can override this method to generate content for an ASP.NET page. For more information, see. The HtmlTextWriter object that receives the server control content.
RenderChildren
Outputs the content of a server control's children to a provided System.Web.UI.HtmlTextWriter object, which writes the content to be rendered on the client.
This method uses the delegate specified in the System.Web.UI.Control.SetRenderMethodDelegate(System.Web.UI.RenderMethod) method to render any Active Server Pages (ASP) code on the page. If no ASP code exists on the page, this method renders any child controls for the server control. The HtmlTextWriter object that receives the child controls.
RenderControl
Outputs server control content to a provided System.Web.UI.HtmlTextWriter object, then checks if tracing is enabled for the containing page and retrieves trace information about the server control.
If a server control's System.Web.UI.Control.Visible property is set to true, this method checks to see if tracing is enabled for the page, and renders the server control content to the page. The HtmlTextWriter object that receives the control content.
ResolveUrl
Resolves a relative URL to the absolute URL where the page or user control associated with this request resides.
Return Value: The absolute URL.
This method uses the System.Web.UI.Control.TemplateSourceDirectory property to resolve to the absolute URL. The returned URL is for client use, and contains the session cookie if appropriate. The relative URL associated with the HTTP request.
SaveViewState
Saves any server control view-state changes that have occurred since the time the page was posted back to the server.
Return Value: Returns the server control's current view state. If there is no view state associated with the control, this method returns null.
View state is the accumulation of the values of a server control's properties. These values are automatically placed in the server control's System.Web.UI.Control.ViewState property, which is an instance of the System.Web.UI.StateBag class. This property's value is then persisted to a string object after the save state stage of the server control life cycle. For more information, see.
SetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
This method is supplied for implementation purposes only; you should never call it directly. The information necessary to pass to the delegate so that it can render the server control.
IParserAccessor.AddParsedSubObject
TrackViewState
Causes tracking of view-state changes to the server control so they can be stored in the server control's System.Web.UI.StateBag object. This object is accessible through the System.Web.UI.Control.ViewState property.
Invoke this method when you develop templated data-bound controls. This method alerts ASP.NET to monitor changes to a server control's view state, which is required when you override the System.Web.UI.Control.DataBind method. For more information, see.
ControlBuilder class (System.Web.UI)
TrackViewState
Description
Supports the parser to build a control and the child controls it contains.
By default every control in a page is associated with a default ControlBuilder class. This class adds a child control to the Controls collection for every nested control that it encounters within custom control tags. Additionally, it adds literal controls for text between nested control tags. You can override this default behavior by defining your own custom control builder class. This is done by applying a control builder attribute to your control builder class as follows:
ControlBuilder
Example Syntax:
TrackViewState
ControlType
TrackViewState
Gets the type for the control to be created. This can be a class type, an interface type, a value type and so on.
FChildrenAsProperties
TrackViewState
Checks if there are children controls to be parsed.
true if there are children controls to be parsed, false otherwise.
FIsNonParserAccessor
TrackViewState
Checks if the control implements the System.Web.UI.IParseAccessor interface.
This is a read only property. It is true if the controls implements the System.Web.UI.IParseAccessor interface, otherwise it returns false.
HasAspCode
TrackViewState
Gets a value indicating whether the control contains any Active Server Pages (ASP) code.
ID
TrackViewState
Gets or sets the ID property for the control to be built.
InDesigner
TrackViewState
Allows to change the behavior of control builders.
NamingContainerType
TrackViewState
Gets the type assigned to the control's naming container.
Parser
TrackViewState
Gets the control builder parser.
TagName
TrackViewState
Gets the tag name for the control to be built.
AllowWhitespaceLiterals
Allows spaces within a control to be created as a LiteralControl object. If you create a custom control builder, you can override this method Return Value: true in all cases.
AppendLiteralString
Adds literal content to a control. Literal content is any text that is passed through to the browser without being processed on the server. For example, any HTML elements and text between their opening and closing tags are literal content. The content to add to the control.
AppendSubBuilder
Adds builders to the System.Web.UI.ControlBuilder object for any child controls that belong to the control. The ControlBuilder object assigned to the child control.
CloseControl
Inserts the closing tag for the control.
CreateBuilderFromType
Creates a System.Web.UI.ControlBuilder object for the specified tag.
Return Value: The builder that is responsible for creating the control. The System.Web.UI.TemplateParser object responsible for parsing the control. The System.Web.UI.ControlBuilder object responsible for building the control. The type assigned to the control that the builder will create. The name of the tag to be built. This allows the builder to support multiple tag types. The ID attribute assigned to the control. The System.Collections.IDictionary object that holds all of the specified tags attributes. The source file line number for the specified control. The name of the source file from which the control is to be created.
GetChildControlType
Obtains the Type for the current control's children.
Return Value: If a default property exists, this method returns the default property builder. If the type is a collection, a collection builder; if the type is a template, a template builder. If none of the above, this method returns the type of the property, or null if there are no properties. The name of the current control's tag. An array of attributes contained in the current control.
HasBody
Determines if a control has both an opening and closing tag.
Return Value: true if the control has an opening and closing tag; otherwise, false.
HtmlDecodeLiterals
Checks if the literal string of an HTML control must be decoded.
Return Value: true if the HTML control literal string is to be decoded, false otherwise.
Init
Initializes the control builder when a Web request is made. The System.Web.UI.TemplateParser object responsible for parsing the control. The System.Web.UI.ControlBuilder object responsible for building the control. The type assigned to the control that the builder will create. The name of the tag to be built. This allows the builder to support multiple tag types. The ID attribute assigned to the control. The System.Collections.IDictionary object that holds all of the specified tags attributes.
NeedsTagInnerText
Determines if a control tag needs inner text. If so, the System.Web.UI.ControlBuilder.SetTagInnerText(System.String) method must be called.
Return Value: true if the control tag does not have any inner text; otherwise, false. The default is false.
OnAppendToParentBuilder
Notifies the current control builder that it is being added to a parent control builder. The ControlBuilder object to which the current builder is added.
SetTagInnerText
Provides the builder with the inner text of the control tag. The text to be provided.
ControlBuilderAttribute class (System.Web.UI)
ToString
Description
Specifies a custom System.Web.UI.ControlBuilder object for building a control within the ASP.NET parser. This class cannot be inherited.
This attribute prefixes the class to be used by the control builder at to create a custom control at run time.
ToString
Specifies the new System.Web.UI.ControlBuilderAttribute object. By default, the new object is set to null. This field is read-only.
ControlBuilderAttribute
Example Syntax:
ToString
Specifies the control builder for a custom control.
The association of the control builder type with a custom control is obtained by preeceding the custom control builder class with the following attribute definition: [ControlBuilderAttribute(typeof(controlbuildertype))] control builder type
BuilderType
ToString
Gets the type assigned to the control. This property is read-only.
TypeId
Equals
Determines the control builder type for the specified control.
GetHashCode
Returns the hash code for the control object.
Return Value: int representing the control object hash code
IsDefaultAttribute
Determines the current is the default control builder.
Return Value: true if the current is the default control builder.
ControlCollection class (System.Web.UI)
ToString
Description
Provides a collection container that enables ASP.NET server controls to maintain a list of their child controls.
You can access any of the properties and methods of the ControlCollection class through the System.Web.UI.Control.Controls property. Since the Control class is the base class for all ASP.NET server controls, all server controls inherit this property.
ControlCollection
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.ControlCollection class for the parent server control specified in the owner parameter. The ASP.NET server control that the control collection is created for.
Count
ToString
Gets the number of server controls in the ControlCollection object for the specified ASP.NET server control.
IsReadOnly
ToString
Gets a value indicating whether the ControlCollection object is read-only.
IsSynchronized
ToString
Gets a value indicating whether the ControlCollection is synchronized.
Item
ToString
Gets a reference to the server control at the specified index location in the ControlCollection object. The location of the server control in the ControlCollection.
Owner
ToString
Gets the ASP.NET server control to which the System.Web.UI.ControlCollection object belongs.
SyncRoot
ToString
Gets an object that can be used to synchronize access to the collection of controls.
Add
Adds the specified System.Web.UI.Control object to the collection.
The new control is added to the end of an ordinal index array. The control can be an instance of any ASP.NET server control, a custom server control you create, or a literal control. The Control object to add to the collection.
AddAt
Adds the specified System.Web.UI.Control object to the collection at the specified index location.
The added control can be an instance of any ASP.NET server control, a custom server control you create, or a literal control. The location in the array to add the child control. The Control object to add to the collection.
Clear
Removes all controls from the current server control's System.Web.UI.ControlCollection object.
Use this method to empty a custom control's ControlCollection when you override the System.Web.UI.Control.CreateChildControls and System.Web.UI.Control.DataBind methods. Do this when you develop composite, templated controls or templated data bound controls. For more information, see.
Contains
Determines whether the specified server control is in the parent server control's System.Web.UI.ControlCollection object.
Return Value: true if the specified server control exists in the collection; otherwise, false. The server control to search for in the collection.
CopyTo
Copies the child controls stored in the System.Web.UI.ControlCollection object to an System.Array object, beginning at the specified index location in the Array. The Array to copy the child controls to. The zero-based relative index in array where copying begins.
GetEnumerator
Retrieves an enumerator that can iterate through the ControlCollection object.
Return Value: The enumerator to iterate through the collection.
IndexOf
Retrieves the index of a specified System.Web.UI.Control object in the collection.
Return Value: The index of the specified server control. If the server control is not currently a member of the collection, it returns −1.
Use this method to determine the index location of the specified server control in the ControlCollection object. The Control object for which the index is returned.
Remove
Removes the specified server control from the parent server control's System.Web.UI.ControlCollection object.
To remove a control from an index location, use the System.Web.UI.ControlCollection.RemoveAt(System.Int32) method. The server control to be removed.
RemoveAt
Removes a child control, at the specified index location, from the System.Web.UI.ControlCollection object.
To remove a control from the collection based on its value, use the System.Web.UI.ControlCollection.Remove(System.Web.UI.Control) method. The ordinal index of the server control to be removed from the collection.
CssStyleCollection class (System.Web.UI)
ToString
Description
Contains the HTML cascading-style sheets (CSS) inline style attributes for a specified HTML server control. This class cannot be inherited.
Any style declared for a particular HTML server control is added to the collection when the containing Web Forms page is parsed. It automatically parses and exposes CSS properties through a dictionary pattern API. You can manipulate any CSS property on a server control through the System.Web.UI.HtmlControls.HtmlControl.Style property. Simply use the CSS property's key and value in the indexed collection.
Count
ToString
Gets the number of items in the CssStyleCollection object.
Item
ToString
Gets or sets a specified CSS value for the specified HTML server control. The index to the CSS attribute.
Keys
ToString
Gets a collection of keys to all the styles in the CssStyleCollection object for a specific HTML server control.
Add
Adds a style item to the CssStyleCollection object. The index assigned to the new style in the collection. The style to store in the collection.
Clear
Removes all style items from the CssStyleCollection object.
Remove
Removes a style item from the CssStyleCollection object. The index of the style item to remove.
DataBinder class (System.Web.UI)
ToString
Description
Provides design-time support for RAD designers to generate and parse. This class cannot be inherited.
You can use the overloaded System.Web.UI.DataBinder.Eval(System.Object,System.String) method of this class in Web Forms page data-binding syntax. This provides an easier syntax to remember than standard data binding, but because DataBinder.Eval provides automatic type conversion, can result in slower server response times.
DataBinder
Example Syntax:
ToString
Eval
Evaluates data binding expressions at runtime.
Return Value: An System.Object that results from the evaluation of the data-binding expression.
While this method is automatically called when you create data bindings in a RAD designer, you can also use it declaratively if you want to simplify the casting to a text string to be displayed on a browser. To do so, you must place the tags, which are also used in standard ASP.NET data binding, around the data-binding expression. The object reference against which the expression is evaluated. This must be a valild object identifier in the page's specified language. The navigation path from the container to the property value to be placed in the bound control property. This must be a string type of property or field names separated by dots, such as Table.DefaultView.Price.
Eval
Evaluates data binding expressions at runtime and formats the output as text to be displayed in the requesting browser.
Return Value: A System.String that results from the evaluation of the data binding expression and conversion to a string type. This will be displayed by the requesting browser.
To learn more about format strings in the .NET Framework, see. The object reference against which the expression is evaluated. This must be a valild object identifier in the page's specified language. The navigation path from the container to the property value to be placed in the bound control property. This must be a string of property or field names separated by dots, such as Table.DefaultView.Price. A .NET Framework format string that converts the System.Object (which results from the evaluation of the data binding expression) to a System.String that can be displayed by the requesting browser.
GetIndexedPropertyValue
GetIndexedPropertyValue
GetPropertyValue
GetPropertyValue
DataBinding class (System.Web.UI)
ToString
Description
Contains information about a single data-binding expression in an ASP.NET server control, which allows rapid-application development (RAD) designers, such as Visual Studio .NET, to create data-binding expressions at design time. This class cannot be inherited.
Each data-binding expression in a server control is represented at design time by an instance of the DataBinding class. Any server control that contains one or more data-binding expressions has a System.Web.UI.DataBindingCollection object that contains the DataBinding objects. This collection is accessible by implementing the System.Web.UI.IDataBindingsAccessor interface. Any DataBinding or DataBindingCollection objects associated with a server control exist only at design time. They do not exist at runtime and, therefore, are not accessible then.
DataBinding
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.DataBinding class. The property to data bind to. The .NET Framework type of the property to data bind to. The data-binding expression to be evaluated.
Expression
ToString
Gets or sets the data-binding expression to be evaluated.
Whether or not you bind data to a server control property, data-binding expressions take the following form:
PropertyName
ToString
Gets the name of the ASP.NET server control property to be data bound against.
PropertyType
ToString
Gets the .NET Framework type of the data-bound ASP.NET server control property.
Equals
Determines whether the specified object is the same instance of the System.Web.UI.DataBinding class as the current object.
Return Value: true if the data binding property names match; otherwise, false. The object to compare against the current DataBinding object.
GetHashCode
Retrieves the hash code for an instance of the System.Web.UI.DataBinding object.
Return Value: A 32-bit signed integer hash code.
DataBinding objects are placed in a System.Web.UI.DataBindingCollection object, accessible at design time through the server control's System.Web.UI.Control.DataBindings property, which is a hash table that represents the bindings on a control. There can only be one binding per property, so the hashcode computation should match the System.Web.UI.DataBinding.Equals(System.Object) implementation and only take the property name into account.
DataBindingCollection class (System.Web.UI)
ToString
Description
Provides a collection of System.Web.UI.DataBinding objects for an ASP.NET server control. This class cannot be inherited.
This collection is a hash table containing all of the System.Web.UI.DataBinding objects on an ASP.NET server control. You can access the objects contained in this collection by implementing the System.Web.UI.IDataBindingsAccessor interface. Any DataBinding or DataBindingCollection objects associated with a server control exist only at design time. They do not exist at runtime and, therefore, are not accessible then.
DataBindingCollection
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.DataBindingCollection class.
Count
ToString
Gets the number of System.Web.UI.DataBinding objects in the System.Web.UI.DataBindingCollection object.
IsReadOnly
ToString
Gets a value indicating whether the System.Web.UI.DataBindingCollection is read-only.
IsSynchronized
ToString
Gets a value indicating whether the System.Web.UI.DataBindingCollection is synchronized (thread-safe).
Item
ToString
Gets the System.Web.UI.DataBinding object with the specified property name. The name of the property to be found.
RemovedBindings
ToString
Gets an array of the names of the System.Web.UI.DataBinding objects removed from the collection.
SyncRoot
ToString
Gets an object that can be used to synchronize access to the System.Web.UI.DataBindingCollection.
Add
Adds the specified System.Web.UI.DataBinding object to the System.Web.UI.DataBindingCollection. The data binding object to add.
Clear
Removes all System.Web.UI.DataBinding objects from the System.Web.UI.DataBindingCollection.
CopyTo
Copies the DataBindingCollection values to a one-dimensional System.Array, beginning at the Array object's specified index. The one-dimensional System.Array object that is the destination of the values copied from DataBindingCollection. The index in the array, specified by the array parameter, where copying begins.
GetEnumerator
Returns an enumerator to iterate through the System.Web.UI.DataBindingCollection object.
Return Value: An System.Collections.IEnumerator that contains the collection's members.
Remove
Removes the specified System.Web.UI.DataBinding object from the System.Web.UI.DataBindingCollection. The System.Web.UI.DataBinding object to be removed from the System.Web.UI.DataBindingCollection.
Remove
Remove
Removes the System.Web.UI.DataBinding object, associated with the specified property name, from the System.Web.UI.DataBindingCollection and instructs the collection not to add the removed DataBinding object to the System.Web.UI.DataBindingCollection.RemovedBindings list. The property associated with the DataBinding object to be removed. A Boolean that indicates whether to add the property name to the RemovedBindings list.
DataBindingHandlerAttribute class (System.Web.UI)
ToString
Description
Specifies a design-time class that performs databinding of controls within a designer.
ToString
Defines the default constructor for the System.Web.UI.DataBindingHandlerAttribute class. This field is read-only.
DataBindingHandlerAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.DataBindingHandlerAttribute class using no parameters. This is the default constructor.
DataBindingHandlerAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.DataBindingHandlerAttribute class with the specified type name.
The syntax for this attribute is: [DataBindingHandlerAttribute typeof((dataBindingHandlerType))] The name of the data binding handler's type.
DataBindingHandlerAttribute
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.DataBindingHandlerAttribute class of the specified Type. The type name for this constructor is the fully-qualified name of the type, including the assembly name from which it was loaded. The Type assigned to the data binding handler.
HandlerTypeName
ToString
Gets the type name of the data binding handler. If the type name is null, this property returns an empty string.
TypeId
DataBoundLiteralControl class (System.Web.UI)
ToString
Description
Creates a control for HTML text that does not contain code processed on the server, but persists the value of its System.Web.UI.DataBoundLiteralControl.Text property to view state. This class cannot be inherited.
This class allows the data binding syntax to be implemented.
DataBoundLiteralControl
Example Syntax:
ToString
ChildControlsCreated
ClientID
Context
Controls
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
TemplateSourceDirectory
Text
ToString
Description
Gets or sets the text content of the System.Web.UI.DataBoundLiteralControl object.
UniqueID
ViewState
ViewStateIgnoresCase
Visible
CreateControlCollection
Creates an System.Web.UI.EmptyCollectionControl object for the current instance of the System.Web.UI.DataBoundLiteralControl.
Return Value: The EmptyCollectionControl object for the current control.
LoadViewState
Loads the previously saved view state. You can override this method to synchronize System.Web.UI.DataBoundLiteralControl.Text property with new literal content. The previously saved view state.
Render
Writes the content of the System.Web.UI.DataBoundLiteralControl object to an output stream. The output stream that renders HTML content to the client.
SaveViewState
Saves any view state modified after the control began monitoring state changes.
Return Value: An System.Object that contains the savied view state values.
SetDataBoundString
SetStaticString
DesignerDataBoundLiteralControl class (System.Web.UI)
TrackViewState
Description
Simpler version of DataBoundLiteralControlBuilder, used at design time.
DesignerDataBoundLiteralControl
Example Syntax:
TrackViewState
ChildControlsCreated
ClientID
Context
Controls
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
TemplateSourceDirectory
Text
TrackViewState
Description
Gets or sets the text content of the data-bound literal control.
UniqueID
ViewState
ViewStateIgnoresCase
Visible
CreateControlCollection
LoadViewState
Loads the previously saved state. Overridden to synchronize Text property with LiteralContent.
Render
Saves any state that was modified after the control began monitoring state changes.
SaveViewState
The object that contains the state changes.
DesignTimeParseData class (System.Web.UI)
TrackViewState
DesignTimeParseData
Example Syntax:
TrackViewState
DataBindingHandler
TrackViewState
DesignerHost
TrackViewState
DocumentUrl
TrackViewState
ParseText
TrackViewState
DesignTimeTemplateParser class (System.Web.UI)
ToString
ParseControl
ParseTemplate
EmptyControlCollection class (System.Web.UI)
ToString
Description
Provides standard support for a ControlCollection that is always empty.
This class is used when you want to define a custom control that does not allow child controls.
EmptyControlCollection
Example Syntax:
ToString
Instantiates an empty control collection.
Count
IsReadOnly
IsSynchronized
Item
Owner
SyncRoot
Add
Denies the addition of the specified System.Web.UI.Control object to the collection.
AddAt
Denies the addition of the specified System.Web.UI.Control object to the collection, at the specified index position.
Html32TextWriter class (System.Web.UI)
ToString
Description
Provides a text writer for ASP.NET server controls that render content to downlevel clients only.
Html32TextWriter
Example Syntax:
ToString
System.Web.UI.Html32TextWriter
Description
Initializes a new instance of the System.Web.UI.Html32TextWriter class that uses the System.Web.UI.HtmlTextWriter.DefaultTabString constant when indentation of a line is necessary. The System.IO.TextWriter object to render the HMTL content.
Html32TextWriter
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Html32TextWriter class using the specified tab spacing. The System.IO.TextWriter object to render the HMTL content. A System.String that represents the number of spaces defined in the System.Web.UI.HtmlTextWriter.Indent property.
Encoding
FontStack
ToString
Description
Gets a collection of font information for the HTML to render.
FormatProvider
Indent
InnerWriter
NewLine
TagKey
TagName
GetTagName
Obtains the HTML element associated with the specified System.Web.UI.HtmlTextWriterTag enumeration value. Return Value: The HTML element.
If HtmlTextWriterTag.Div is passed in the tagKey parameter, this method returns the HTML element. The HtmlTextWriterTag value to obtain the HTML element for.
OnStyleAttributeRender
Determines whether the specified HTML style attribute and its value have been rendered to the requesting page.
Return Value: true if the HTML style attribute and its value have been rendered to the requesting page; otherwise, false.
This method supports a smaller number of HTML style attributes than the of the System.Web.UI.HtmlTextwriter.OnStyleAttributeRender(System.String,System.String,System.Web.UI.HtmlTextWriterStyle) method which it overrides. The HTML style attribute to render to the client. The value associated with the HTML style attribute. The System.Web.UI.HtmlTextWriterStyle enumeration value associated with the HTML style attribute.
OnTagRender
Determines whether the specified HTML element has been rendered to the requesting page.
Return Value: true if the HTML element has been rendered to the requesting page; otherwise false.
This method associates the element with an HTML table to simplify page layout for browsers that do not support this element. The HTML element to render. The System.Web.UI.HtmlTextWriterTag enumeration value associated with the HTML element.
RenderAfterContent
Writes any text or spacing that occurs after the content of the HTML element to the System.Web.UI.HtmlTextWriter output stream.
Return Value: The spacing or text to write prior to the content of the HTML element. If there is no such information to render, this method returns null.
RenderAfterTag
Writes any spacing or text that occurs after an HTML element's closing tag.
Return Value: The spacing or text to write after the closing tag of the HTML element. If there is no such information to render, this method returns null.
RenderBeforeContent
Writes any tab spacing or font information that appears before the content contained in an HTML element.
Return Value: The font information or spacing to write prior to the content of the HTML element. If there is no such information to render, this method returns null.
RenderBeforeTag
Writes any text or tab spacing that occurs before the opening tag of an HTML element to the System.Web.UI.HtmlTextWriter output stream. Return Value: Any HTML font and spacing information to render before the tag; if there is no such information to render, this method returns null.
RenderBeginTag
Writes the opening tag of the specified HTML element to the System.Web.UI.HtmlTextWriter output stream.
If the element is specified, this method performs basic HTML formatting to present the HTML content. The System.Web.UI.HtmlTextWriterTag enumeration value that indicates the HTML element to write.
RenderEndTag
Writes the end tag of an HTML element to the System.Web.UI.HtmlTextWriter output stream along with any font information that is associated with the element.
HtmlTextWriter class (System.Web.UI)
WriteStyleAttribute
Description
Represents a writer that writes a sequential series of HTML-specific characters and text. This class provides formatting capabilities that ASP.NET server controls use when rendering HTML content to clients.
This class is commonly used to render HTML to a Web Forms page. Use it as an output stream when you override the System.Web.UI.Control.Render(System.Web.UI.HtmlTextwriter), System.Web.UI.LiteralControl.Render(System.Web.UI.HtmlTextwriter), and other ASP.NET server control methods that write content to a Web page.
WriteStyleAttribute
Description
Represents the characters that make up the default tab.
WriteStyleAttribute
Represents a double-quote character.
WriteStyleAttribute
Represents the left angle bracket and closing forward slash for a closing tag of an HTML element.
WriteStyleAttribute
Represents the equal sign character.
WriteStyleAttribute
Represents an equal sign, a forward slash, and a double quote character together in a System.String.
WriteStyleAttribute
Represents the self-closing forward slash character of an HTML tag.
This charcter is used in HTML elements that are self-closed. For example,.
WriteStyleAttribute
Represents the closing forward slash and right angle bracket of a self-closing HTML element.
WriteStyleAttribute
Represents the semicolon character.
WriteStyleAttribute
Represents a single quote character.
WriteStyleAttribute
Represents the backslash character.
WriteStyleAttribute
Represents a space character.
WriteStyleAttribute
Represents the colon character.
WriteStyleAttribute
Represents the opening angle-bracket character of an HTML tag.
WriteStyleAttribute
Represents the closing angle-bracket character of an HTML tag.
HtmlTextWriter
Example Syntax:
WriteStyleAttribute
Initializes a new instance of the System.Web.UI.HtmlTextWriter class that uses the System.Web.UI.HtmlTextWriter.DefaultTabString constant when indentation of a line is necessary. The System.IO.TextWriter object to render the HMTL content.
HtmlTextWriter
Example Syntax:
WriteStyleAttribute
Initializes a new instance of the System.Web.UI.HtmlTextWriter class with the line indenation as specified in the tabString parameter. The System.IO.TextWriter object to render the HMTL content. A System.String that represents the number of spaces defined in the System.Web.UI.HtmlTextWriter.Indent property.
Encoding
WriteStyleAttribute
Gets the System.Text.Encoding that the System.Web.UI.HtmlTextWriter object uses to write content to the page.
FormatProvider
Indent
WriteStyleAttribute
Description
Gets or sets the number of spaces to indent at the beginning of a line.
InnerWriter
WriteStyleAttribute
Gets the text writer that writes the inner content of the HTML element.
NewLine
WriteStyleAttribute
Gets or sets the line terminator string used by the current System.Web.UI.HtmlTextWriter.
The default line terminator string is a carriage return followed by a line feed (“\r\n”).
TagKey
WriteStyleAttribute
Gets or sets the System.Web.UI.HtmlTextWriterTag value for the specified HTML element.
TagName
WriteStyleAttribute
Gets or sets the name of the HTML element to be written to the rendered page.
AddAttribute
Adds the HTML attribute associated with the specified System.Web.UI.HtmlTextWriterAttribute key and the specified value to the System.Web.UI.HtmlTextWriter output stream. An HtmlTextWriterAttribute value that represents the HTML attribute. The value to assign to the HTML attribute.
AddAttribute
Adds the specified HTML attribute and value to the HtmlTextWriter output stream. The HTML attribute to add. The value to assign to the HTML attribute.
AddAttribute
Adds the HTML attribute associated with the System.Web.UI.HtmlTextWriterAttribute value specified by the key parameter, the specified attribute value, and a value that indicates if the attribute and value should be HTML encoded to the System.Web.UI.HtmlTextWriter output stream. An HtmlTextWriterAttribute value that represents the HTML attribute. The value to assign to the HTML attribute. true to HTML encode the attribute and its value; otherwise, false.
AddAttribute
Adds the specified HTML attribute and value to the HtmlTextWriter output stream, with a value that indicates if the attribute and value should be HTML encoded. The HTML attribute to add. The value to assign to the HTML attribute. true to HTML encode the attribute and its value; otherwise, false.
AddAttribute
Adds the specified HTML attribute and its value, along with an System.Web.UI.HtmlTextWriterAttribute value, to the HtmlTextWriter output stream. The HTML attribute to add. The value to assign to the HTML attribute. An HtmlTextWriterAttribute value that represents the HTML attribute.
AddStyleAttribute
Adds the HTML style attribute associated with the System.Web.UI.HtmlTextWriterStyle value specified by the key parameter and the attribute's value to the System.Web.UI.HtmlTextWriter output stream. An HtmlTextWriterStyle value that represents the HTML style attribute to add. The value to assign to the HTML attribute.
AddStyleAttribute
Adds the specified HTML style attribute and its value to the System.Web.UI.HtmlTextWriter output stream. The HTML style attribute to add. The value assigned to the HTML style attribute.
AddStyleAttribute
Adds the specified HTML style attribute, along with its value, to the System.Web.UI.HtmlTextWriter output stream. The HTML style attribute to add to the output stream. The value to assign to the HTML attribute. An System.Web.UI.HtmlTextWriterStyle value that represents the HTML style attribute to add.
Close
Closes the current System.Web.UI.HtmlTextWriter and releases any system resources associated with it.
This implementation of Close calls the System.IO.TextWriter method passing a true value.
EncodeAttributeValue
HTML encodes the specified HTML attribute's value.
Return Value: The encoded attribute value. An System.Web.UI.HtmlTextWriterAttribute value representing the HTML attribute to which the value parameter is assigned. The value assigned to the specified HTML attribute.
EncodeAttributeValue
HTML encodes the specified HTML attribute's value.
Return Value: The HTML-encoded attribute value, null if the value parameter is empty, or the unencoded attribute value if fEncode is false. The attribute value to encode. true to HTML encode the attribute value; otherwise, false.
EncodeUrl
Performs minimal URL encoding by converting spaces passed in the url parameter to “%20”.
Return Value: The encoded URL. The URL to be encoded.
FilterAttributes
Renders all HTML attributes and style attributes by calling System.Web.UI.HtmlTextwriter.OnAttributeRender(System.String,System.String,System.Web.UI.HtmlTextWriterAttribute) and System.Web.UI.HtmlTextwriter.OnStyleAttributeRender(System.String,System.String,System.Web.UI.HtmlTextWriterStyle)on all properties of the page or ASP.NET server control.
Flush
Clears all buffers for the current System.Web.UI.HtmlTextWriter and causes any buffered data to be written to the text stream.
GetAttributeKey
Obtains the corresponding System.Web.UI.HtmlTextWriterAttribute enumeration value for the specified HTML attribute.
Return Value: The HtmlTextWriterAttribute enumeration value for the specified HTML attribute. The HTML attribute to obtain the HtmlTextWriterAttribute value for.
GetAttributeName
Obtains the name of the HTML attribute associated with the specified System.Web.UI.HtmlTextWriterAttribute value.
Return Value: The name of the HTML attribute. The HtmlTextWriterAttribute to obtain the HTML attribute name for.
GetStyleKey
Obtains the System.Web.UI.HtmlTextWriterStyle enumeration value for the specified HMTL style.
Return Value: The HtmlTextWriterStyle value. The HTML style attribute to obtain the HtmlTextWriterStyle value for.
GetStyleName
Obtains the HTML style attribute associated with the specified System.Web.UI.HtmlTextWriterStyle enumeration value.
Return Value: The HTML style attribute. The HtmlTextWriterStyle value to obtain the HTML style attribute for.
GetTagKey
Obtains the System.Web.UI.HtmlTextWriterTag enumeration value associated with the specified HTML element.
Return Value: The HtmlTextWriterTag value; if the tagName parameter is not associated with a specific HtmlTextWriterTag value, HtmlTextWriterTag.Unknown is returned. The HTML element to obtain the HtmlTextWriterTag value for.
GetTagName
Obtains the HTML element associated with the specified System.Web.UI.HtmlTextWriterTag enumeration value.
Return Value: The HTML element. The HtmlTextWriterTag value to obtain the HTML element for.
IsAttributeDefined
Determines whether the specified HTML attribute is recognized.
Return Value: true if the HTML attribute is associated with one of the HtmlTextWriterAttribute values; otherwise, false. The System.Web.UI.HtmlTextWriterAttribute associated with the HTML attribute.
IsAttributeDefined
Determines whether the specified HTML attribute is recognized.
Return Value: true if the HTML attribute is associated with one of the HtmlTextWriterAttribute values; otherwise, false. The System.Web.UI.HtmlTextWriterAttribute associated with the HTML attribute. The value assigned to the HTML attribute.
IsStyleAttributeDefined
Determines whether the specified HTML style attribute is recognized.
Return Value: true if the HTML attribute is associated with one of the HtmlTextWriterStyle values; otherwise, false. The System.Web.UI.HtmlTextWriterStyle value associated with the HTML attribute.
IsStyleAttributeDefined
Determines whether the specified HTML style attribute is recognized.
Return Value: true if the HTML attribute is associated with one of the HtmlTextWriterStyle values; otherwise, false. The System.Web.UI.HtmlTextWriterStyle value associated with the HTML attribute. The value assigned to the HTML style attribute.
OnAttributeRender
Determines whether the specified HTML attribute and its value have been rendered to the requesting page.
Return Value: true if the attribute has been rendered to the page; otherwise, false. The HTML attribute to render. The value that is assigned to the HTML attribute. The System.Web.UI.HtmlTextWriterAttribute enumeration value associated with the HTML attribute.
OnStyleAttributeRender
Determines whether the specified HTML style attribute and its value have been rendered to the requesting page.
Return Value: true if the HTML style attribute has been rendered to the page; otherwise, false. The HTML style attribute to render. The value that is assigned to the HTML style attribute. The System.Web.UI.HtmlTextWriterStyle enumeration value associated with the HTML style attribute.
OnTagRender
Determines whether the specified HTML element has been rendered to the requesting page.
Return Value: true if the HTML element has been rendered to the page; otherwise, false. The HTML element to render. The System.Web.UI.HtmlTextWriterTag enumeration value associated with the HTML element.
OutputTabs
Writes a series of blank characters that represent the tab spacing for a line of HTML characters.
This method uses the integer passed to the System.Web.UI.HtmlTextWriter.Indent property to determine how many spaces to write for the tab spacing.
PopEndTag
Retrieves the appropriate closing tag for the HTML element to render to the page.
Return Value: The appropriate closing tag for the HTML element.
PushEndTag
Associates the specified closing tag of an HTML element with the appropriate HTML text. The closing tag to be associated.
RegisterAttribute
Registers HTML attributes, whether literals or dynamically generated, from the source file so that they can be properly rendered to the requesting client. The HTML attribute to be registered. An System.Web.UI.HtmlTextWriterAttribute value that corresponds to the attribute name.
RegisterStyle
Registers HTML style properties, whether literals or dynamically generated, from the source file so that they can be properly rendered to the requesting client. The System.String passed from the source file specifying the style name. The System.Web.UI.HtmlTextWriterStyle value that corresponds to the specified style.
RegisterTag
Registers HTML tags, whether literals or dynamically generated, from the source file so that they can be properly rendered to the requesting client. A System.String that contains the HTML tag. An System.Web.UI.HtmlTextWriterTag value that specifies which element is to be rendered.
RenderAfterContent
Writes any text or spacing that occurs after the content of the HTML element to the System.Web.UI.HtmlTextWriter output stream.
Return Value: The spacing or text to write prior to the content of the HTML element. If not overridden, this method returns null.
RenderAfterTag
Writes any spacing or text that occurs after an HTML element's closing tag.
Return Value: The spacing or text to write after the closing tag of the HTML element. If not overridden, this method returns null.
RenderBeforeContent
Writes any tab spacing before the content contained in an HTML element.
Return Value: The spacing to write prior to the content of the HTML element. If not overridden, this method returns null.
RenderBeforeTag
Writes any text or tab spacing that occurs before the opening tag of an HTML element to the System.Web.UI.HtmlTextWriter output stream.
Return Value: The text or tab spacing to write to the output stream. If not overridden, this method returns null.
RenderBeginTag
Writes the opening tag of the HTML element associated with the specified System.Web.UI.HtmlTextWriterTag enumeration value to the output stream. An HtmlTextWriterTag value that defines the opening tag of the HTML element to render.
RenderBeginTag
Writes the opening tag of the specified HTML element to the output stream. The HTML element to render the opening tag for.
RenderEndTag
Writes the end tag of an HTML element to the System.Web.UI.HtmlTextWriter output stream.
Write
Writes the text representation of a Boolean value to the text stream, along with any specified tab spacing. The Boolean value to be written to the text stream.
Write
Writes a unicode character to the text stream, along with any specified tab spacing. The unicode character to write to the text stream.
Write
Writes a character array to the text stream, along with any specified tab spacing. The character array to write to the text stream.
Write
Writes the text representation of a double-precision floating point number to the HTML text stream, along with any specified tab spacing. The double-precision floating point number to write to the text stream.
Write
Writes the text representation of a 32-byte signed integer to the text stream, along with any specified tab spacing. The 32-byte signed integer to write to the text stream.
Write
Writes the text representation of an 64-byte signed integer to the text stream, along with any specified tab spacing. The 64-byte signed integer to write to the text stream.
Write
Writes the text representation of an System.Object to the text stream, along with any specified tab spacing. The Object to write to the text stream.
Write
Writes the text representation of a single-precision floating point number to the HTML text stream, along with any specified tab spacing. The single-precision floating point number to write to the text stream.
Write
Writes the specified string to the text stream, along with any specified tab spacing. A System.String to be written to the text stream.
Write
Writes a tab string and a formatted string to the HTML text stream, using the same semantics as System.String.Format(System.String,System.Object). The formatting string. An object to write into the formatted string.
Write
Writes a tab string and a formatted string to the HTML text stream, using the same semantics as System.String.Format(System.String,System.Object). The formatting string. The object array to write into the formatted string.
Write
Writes a subarray of characters to the text stream, along with any specified tab spacing. The array of characters from which the subarray is written to the text stream. The index location in the array where writing begins. The number of characters to be written to the text stream.
Write
Writes a tab string and a formatted string to the HTML text stream, using the same semantics as System.String.Format(System.String,System.Object). The formatting string. An object to write into the formatted string. An object to write into the formatted string.
WriteAttribute
Writes the specified HTML attribute and value to the System.Web.UI.HtmlTextWriter output stream. The HTML attribute to write to the output stream. The value assigned to the HTML attribute.
WriteAttribute
Writes the specified HTML attribute and value to the System.Web.UI.HtmlTextWriter output stream and HTML encodes them if specified in the fEncode parameter. The HTML attribute to write to the output stream. The value assigned to the HTML attribute. true to HTML encode the attribute and its assigned value; otherwise, false.
WriteBeginTag
Writes any tab spacing and the opening tag of the specified HTML element to the System.Web.UI.HtmlTextWriter output stream.
This method does not write the closing character (>) of the HTML element's opening tag. Use this method with the System.Web.UI.HtmlTextWriter.SelfClosingTagEnd constant when you write HTML elements that are self closing. The HTML element to write the opening tag of.
WriteEndTag
Writes any tab spacing and the closing tag of the specified HTML element. The HTML element to write the closing tag for.
WriteFullBeginTag
Writes any tab spacing and the opening tag of the specified HTML element to the System.Web.UI.HtmlTextWriter output stream.
This method automatically writes the closing character (>) of the opening tag of the HTML element. The HTML element to write.
WriteLine
Writes a line terminator to the HTML text stream.
WriteLine
Writes a tab string and the text representation of a Boolean followed by a line terminator to the HTML text stream. The Boolean to be written to the text stream.
WriteLine
Writes a tab string and a character followed by a line terminator to the HTML text stream. The character to be written to the text stream.
WriteLine
Writes a tab string and a character array followed by a line terminator to the HTML text stream. The character array to be written to the text stream.
WriteLine
Writes a tab string and the text representation of an 8-byte floating-point value, followed by a line terminator, to the HTML text stream. The 8-byte floating-point value to write to the text stream.
WriteLine
Writes a tab string and the text representation of an 32-byte signed integer, followed by a line terminator, to the HTML text stream. The 32-byte signed integer to write to the text stream.
WriteLine
Writes a tab string and the text representation of an 64-byte signed integer, followed by a line terminator, to the HTML text stream. The 64-byte signed integer to write to the text stream.
WriteLine
Writes any tab strings and the text representation of an System.Object, followed by a line terminator, to the HTML text stream. The Object to write to the text stream.
WriteLine
Writes a tab string and the text representation of a single-precision floating point number, followed by a line terminator, to the HTML text stream. The single-precision floating point number to write to the text string.
WriteLine
Writes a tab string and a System.String followed by a line terminator to an HTML text stream. The String to write to the text stream.
WriteLine
Writes any tab strings and the text representation of a 4-byte unsigned integer followed by a line terminator to the HTML text stream. The 4-byte unsigned integer to write.
WriteLine
Writes any tab strings and a formatted string, followed by a line terminator, to the HTML text stream. The method uses the same semantics as System.String.Format(System.String,System.Object). The formatting string. The object to write into the formatted string.
WriteLine
Writes any tab strings and a formatted string, followed by a line terminator, to the HTML text stream. The method uses the same semantics as System.String.Format(System.String,System.Object). The formatting string. The array of objects to write into the formatted string.
WriteLine
Writes a tab string and a subarray of characters followed by a line terminator to the HTML text stream. The character array from which to write to the text stream. The location in the character array where writing begins. The number of characters in the array to write to the text stream.
WriteLine
Writes any tab strings and a formatted string, followed by a line terminator, to the HTML text stream. The method uses the same semantics as System.String.Format(System.String,System.Object). The formatting string. An object to write into the formatted string. An object to write into the formatted string.
WriteLineNoTabs
Writes a System.String followed by a line terminator to an HTML text stream. This method ignores any specified tab spacing. The String to write to the HTML text stream.
WriteStyleAttribute
Writes the specified HTML style attribute to the System.Web.UI.HtmlTextWriter output stream. The HTML style attribute to write to the output stream. The value assigned to the HTML style attribute.
WriteStyleAttribute
Writes the specified HTML attribute and value to the System.Web.UI.HtmlTextWriter output stream and HTML encodes them if specified in the fEncode parameter. The HTML style attribute to write to the output stream. The value assigned to the HTML style attribute. true to HTML encode the style attribute and its assigned value; otherwise, false.
HtmlTextWriterAttribute enumeration (System.Web.UI)
WriteStyleAttribute
Description
Specifies the HTML attributes that an System.Web.UI.HtmlTextWriter or System.Web.UI.Html32TextWriter object writes to the opening tag of an HTML element when a Web request is processed.
WriteStyleAttribute
Specifies that the HTML acesskey attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML align attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML alt attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML background attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML bgcolor attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML border attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML bordercolor attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML cellpadding attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML cellspacing attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML checked attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML class attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML cots attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML colspan attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML disabled attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML for attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML height attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML href attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML id attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML maxlength attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML multiple attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML name attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML nowrap attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML onchange attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML onclick attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML readonly attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML rows attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML rowspan attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML rules attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML selected attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML size attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML src attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML style attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML tabindex attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML target attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML title attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML type attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML valign attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML value attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML width attribute should be written to the tag.
WriteStyleAttribute
Specifies that the HTML wrap attribute should be written to the tag.
HtmlTextWriterStyle enumeration (System.Web.UI)
ToString
Description
Specifies the HTML styles available to an System.Web.UI.HtmlTextWriter or System.Web.UI.Html32TextWriter object output stream.
HtmlTextWriter and Html32TextWriter objects use these enumeration values to register HTML strings to the proper HTML style.
ToString
Specifies the HTML backgroundcolor style.
ToString
Specifies the HTML backgroundimage style.
ToString
Specifies the HTML bordercollapse style.
ToString
Specifies the HTML bordercolor style.
ToString
Specifies the HTML borderstyle style.
ToString
Specifies the HTML borderwidth style.
ToString
Specifies the HTML color style.
ToString
Specifies the HTML fontfamily style.
ToString
Specifies the HTML fontsize style.
ToString
Specifies the HTML fontstyle style.
ToString
Specifies the HTML fontweight style.
ToString
Specifies the HTML height style.
ToString
Specifies the HTML textdecoration style.
ToString
Specifies the HTML width style.
HtmlTextWriterTag enumeration (System.Web.UI)
ToString
Description
Specifies the HTML tags that can be passed to an System.Web.UI.HtmlTextWriter or System.Web.UI.Html32TextWriter object output stream.
This enumeration allows the output stream to write HTML mark up, along with HTML server controls, in response to a Web request.
ToString
Specifies the HTML a element.
ToString
Specifies the HTML acronym element.
ToString
Specifies the HTML address element.
ToString
Specifies the HTML area element.
ToString
Specifies the HTML b element.
ToString
Specifies the HTML base element.
ToString
Specifies the HTML basefont element.
ToString
Specifies the HTML bdo element.
ToString
Specifies the HTML bgsound element.
ToString
Specifies the HTML big element.
ToString
Specifies the HTML blockquote element.
ToString
Specifies the HTML body element.
ToString
Specifies the HTML br element.
ToString
Specifies the HTML button element.
ToString
Specifies the HTML caption element.
ToString
Specifies the HTML center element.
ToString
Specifies the HTML cite element.
ToString
Specifies the HTML code element.
ToString
Specifies the HTML col element.
ToString
Specifies the HTML colgroup element.
ToString
Specifies the HTML dd element.
ToString
Specifies the HTML cel element.
ToString
Specifies the HTML dfn element.
ToString
Specifies the HTML dir element.
ToString
Specifies the HTML div element.
ToString
Specifies the HTML d1 element.
ToString
Specifies the HTML dt element.
ToString
Specifies the HTML em element.
ToString
Specifies the HTML embed element.
ToString
Specifies the HTML fieldset element.
ToString
Specifies the HTML font element.
ToString
Specifies the HTML form element.
ToString
Specifies the HTML frame element.
ToString
Specifies the HTML frameset element.
ToString
Specifies the HTML H1 element.
ToString
Specifies the HTML H2 element.
ToString
Specifies the HTML H3 element.
ToString
Specifies the HTML H4 element.
ToString
Specifies the HTML H5 element.
ToString
Specifies the HTML H6 element.
ToString
Specifies the HTML head element.
ToString
Specifies the HTML hr element.
ToString
Specifies the HTML html element.
ToString
Specifies the HTML i element.
ToString
Specifies the HTML iframe element.
ToString
Specifies the HTML img element.
ToString
Specifies the HTML input element.
ToString
Specifies the HTML ins element.
ToString
Specifies the HTML isindex element.
ToString
Specifies the HTML kbd element.
ToString
Specifies the HTML label element.
ToString
Specifies the HTML legend element.
ToString
Specifies the HTML li element.
ToString
Specifies the HTML link element.
ToString
Specifies the HTML map element.
ToString
Specifies the HTML marquee element.
ToString
Specifies the HTML menu element.
ToString
Specifies the HTML meta element.
ToString
Specifies the HTML nobr element.
ToString
Specifies the HTML noframes element.
ToString
Specifies the HTML noscript element.
ToString
Specifies the HTML object element.
ToString
Specifies the HTML o1 element.
ToString
Specifies the HTML option element.
ToString
Specifies the HTML p element.
ToString
Specifies the HTML param element.
ToString
Specifies the HTML pre element.
ToString
Specifies the HTML q element.
ToString
Specifies the HTML rt element.
ToString
Specifies the HTML ruby element.
ToString
Specifies the HTML s element.
ToString
Specifies the HTML samp element.
ToString
Specifies the HTML script element.
ToString
Specifies the HTML select element.
ToString
Specifies the HTML small element.
ToString
Specifies the HTML span element.
ToString
Specifies the HTML strike element.
ToString
Specifies the HTML strong element.
ToString
Specifies the HTML style element.
ToString
Specifies the HTML sub element.
ToString
Specifies the HTML sup element.
ToString
Specifies the HTML table element.
ToString
Specifies the HTML tbody element.
ToString
Specifies the HTML td element.
ToString
Specifies the HTML textarea element.
ToString
Specifies the HTML tfoot element.
ToString
Specifies the HTML th element.
ToString
Specifies the HTML thead element.
ToString
Specifies the HTML title element.
ToString
Specifies the HTML tr element.
ToString
Specifies the HTML tt element.
ToString
Specifies the HTML u element.
ToString
Specifies the HTML ul element.
ToString
The System.String passed as an HTML tag is not recognized.
ToString
Specifies the HTML var element.
ToString
Specifies the HTML wbr element.
ToString
Specifies the HTML xml element.
IAttributeAccessor interface (System.Web.UI)
ToString
Description
Defines methods used by ASP.NET server controls to provide programmatic access to any attribute declared in the opening tag of a server control.
If you author a custom server control that inherits from the System.Web.UI.WebControls.WebControl, System.Web.UI.HtmlControls.HtmlControl, or System.Web.UI.WebControls.ListItem class, the .NET Framework automatically provides programmatic access to attributes since each of these classes implement the IAttributeAccessor interface.
GetAttribute
When implemented by a class, retrieves the specified attribute property from the server control.
Return Value: The value of the specified attribute. A System.String object that represents the name of the server control attribute.
SetAttribute
When implemented by a class, designates an attribute and its value to assign to the ASP.NET server control. The name of the attribute to be set. The value assigned to the attribute.
IDataBindingsAccessor interface (System.Web.UI)
SetAttribute
Description
Allows access to the collection of databinding expressions on a control at design time.
DataBindings
SetAttribute
Indicates a collection of all data bindings on the control. This property is read-only.
HasDataBindings
SetAttribute
Returns whether the control contains any data binding logic. This method is only accessed by RAD designers.
Return Value: true if the control contains data binding logic; otherwise, false.
ImageClickEventArgs class (System.Web.UI)
SetAttribute
Description
Provides data for any events that occur when a user clicks on a image-based ASP.NET server control, such as the System.Web.UI.HtmlControls.HtmlInputImage or System.Web.UI.WebControls.Image server controls. This class cannot be inherited.
This class passes the location where a user clicked on an HtmlInputImage server control or an Image Web server control. Clicking an HtmlInputImage server control causes a ServerClick event to fire, while clicking an Image server control causes a Click event to occur. You can then use event handlers to programmatically respond to the event based on the value of these coordinates.
SetAttribute
An integer that represents the x-coordinate where a user clicked on an image-based ASP.NET server control.
SetAttribute
An integer that represents the y-coordinate where a user clicked on an image-based ASP.NET server control.
ImageClickEventArgs
Example Syntax:
SetAttribute
Initializes a new instance of the System.Web.UI.ImageClickEventArgs class. The x-coordinate where the user clicked on an image-based ASP.NET server control. The y-coordinate where the user clicked on an image-based ASP.NET server control.
ImageClickEventHandler delegate (System.Web.UI)
ToString
Description
Represents the method that will handle any events that are raised when a user clicks on an image-based ASP.NET server control. The server control that is the source of the event. An System.Web.UI.ImageClickEventArgs object that contains event data.
This delegate defines the required signature for all click events raised when a user clicks on an image-based ASP.NET server control. You must use the signature defined by this delegate for any OnServerClick event handlers that you create for an System.Web.UI.HtmlControls.HtmlInputImage server control or any OnClick event handlers that you create for an System.Web.UI.WebControls.ImageButton Web server control.
INamingContainer interface (System.Web.UI)
ToString
Description
Identifies a container control that creates a new ID namespace within a System.Web.UI.Page object's control hierarchy. This is a marker interface only.
Any control that implements this interface creates a new namespace in which all child control ID attributes are guaranteed to be unique within an entire application. The marker provided by this interface allows unique naming of the dynamically generated server control instances within the Web server controls that support data binding. These controls include the System.Web.UI.WebControls.Repeater control, the System.Web.UI.WebControls.DataGrid control, or the System.Web.UI.WebControls.RadioButtonList control.
IParserAccessor interface (System.Web.UI)
ToString
Description
Defines the method that ASP.NET server controls must implement to recognize when elements, either HTML or XML, are parsed.
When elements are parsed, they are recoginized as children of the server control that implements this interface. As such, they are added to the control's System.Web.UI.Control.Controls property. These elements, generally speaking, are added as System.Web.UI.LiteralControl objects to the System.Web.UI.ControlCollection object associated with Controls property.
AddParsedSubObject
When implemented by an ASP.NET server control, notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's System.Web.UI.ControlCollection object. The System.Object instance to add to the parent control.
IPostBackDataHandler interface (System.Web.UI)
AddParsedSubObject
Description
Defines methods that ASP.NET server controls must implement to automatically load post back data.
If you want a server control you design to examine form data that is posted back to the server by the client, you must implement the IPostBackDataHandler interface. The contract that this interface defines allows a server control to determine whether its state should be altered as a result of the post back, and to raise the appropriate events.
LoadPostData
When implemented by a class, processes post back data for an ASP.NET server control.
Return Value: true if the server control's state changes as a result of the post back; otherwise false.
The Web Forms page framework tracks all of the server control's that return true to this method call, then invokes the System.Web.UI.IPostBackDataHandler.RaisePostDataChangedEvent on those controls. The key identifier for the control. The collection of all incoming name values.
RaisePostDataChangedEvent
When implemented by a class, signals the server control object to notify the ASP.NET application that the state of the control has changed.
Change events for the server control that implements this interface, if any, are raised from this method.
IPostBackEventHandler interface (System.Web.UI)
RaisePostDataChangedEvent
Description
Defines the method ASP.NET server controls must implement to handle post back events.
To create a server control that captures form submit information from the browser, you must implement this interface. For more information on how to use this interface, see.
RaisePostBackEvent
When implemented by a class, enables a server control to process an event raised when a form is posted to the server.
This method provides the functionality for many events implemented by HTML and Web server controls. A System.String that represents an optional event argument to be passed to the event handler.
IStateManager interface (System.Web.UI)
RaisePostBackEvent
Description
Defines the properties and methods any class must implement to support view state management for a server control.
A server control's view state comprises the cumulative values of the control's properties. This interface includes methods that save and load a server control's view state values, as well as a method that instructs the control to track any changes to its view state.
IsTrackingViewState
RaisePostBackEvent
When implemented by a class, gets a value indicating whether a server control is tracking its view state changes.
LoadViewState
When implemented by a class, loads the server control's previously saved view state to the control. An System.Object that contains the saved view state values for the control.
SaveViewState
When implemented by a class, saves the changes to a server control's view state to an System.Object.
Return Value: The Object that contains the view state changes.
TrackViewState
When implemented by a class, instructs the server control to track changes to its view state.
Once this method has been called on a server control, the System.Web.UI.IStateManager.IsTrackingViewState property will return true
ITagNameToTypeMapper interface (System.Web.UI)
TrackViewState
Description
Maps a sequence of text characters to a .NET Framework type when an .aspx file is processed on the server.
Classes that implement this interface strongly type any string in an .aspx file to the appropriate class. HTML and literal text strings are mapped to the type System.Web.UI.LiteralControl, HTML anchor tags with a runat=“server” attribute/value pair are mapped to the type System.Web.UI.HtmlControls.HtmlAnchor, while tags are mapped to the type System.Web.UI.WebControls.Button.
GetControlType
Retrieves the .NET Framework type that processes the control declared in the .aspx file.
Return Value: The .NET Framework type that is assigned to the control. The element name of the control sent from the .aspx file. A collection of the attributes on the control in the .aspx file.
ITemplate interface (System.Web.UI)
GetControlType
Description
Defines the method to implement for populating an ASP.NET server control with child controls when using a the control with inline templates when declared in an .aspx file.
InstantiateIn
When implemented by a class, defines the System.Web.UI.Control object that child controls and templates belong to. These child controls are in turn defined within an inline template.
When developing templated server controls you do not need to implement this method, the .NET Framework provides the implementation for you. The Control object to contain the instantiated controls from the inline template.
IValidator interface (System.Web.UI)
InstantiateIn
Description
Defines the properties and methods that objects that participate in validation must implement.
Classes that implement this interface represent a posssible user input error. When the System.Web.UI.IValidator.Validate method is called, the class updates its System.Web.UI.IValidator.IsValid property to signify whether the error occurred. The System.Web.UI.IValidator.ErrorMessage property contains a text description of the error condition that you can display when the error occurs.
ErrorMessage
InstantiateIn
When implemented by a class, gets or sets the error message text generated when the condition being validated fails.
Web Forms page developers access this property declaratively in the opening tag of a validation server control. For more information, see.
IsValid
InstantiateIn
When implemented by a class, gets or sets a value indicating whether the user-entered content in the specified control passes validation.
Validate
When implemented by a class, evaluates the condition it checks and upates the System.Web.UI.IValidator.IsValid property.
LiteralControl class (System.Web.UI)
Validate
Description
Represents HTML elements, text, and any other strings in an ASP.NET page that do not require processing on the server.
ASP.NET compiles all HTML elements and readable text that do not require server-side processing into instances of this class. For example, an HTML element that does not contain a runat=“server” attribute/value pair in its opening tag is compiled into a LiteralControl object.
LiteralControl
Example Syntax:
Validate
Initializes a new instance of the System.Web.UI.LiteralControl class that contains a literal string to be rendered on the requested ASP.NET page.
LiteralControl
Example Syntax:
Validate
Initializes a new instance of the System.Web.UI.LiteralControl class with the specified text. The text to be rendered on the requested Web page.
ChildControlsCreated
ClientID
Context
Controls
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
TemplateSourceDirectory
Text
Validate
Description
Gets or sets the text content of the System.Web.UI.LiteralControl object.
UniqueID
ViewState
ViewStateIgnoresCase
Visible
CreateControlCollection
Creates an System.Web.UI.EmptyControlCollection object for the current instance of the System.Web.UI.LiteralControl.
Return Value: The EmptyControlCollection object for the current control.
By default, LiteralControl objects contain only text and no child server controls. If you want to change this behavior, you must override this method.
Render
Writes the content of the System.Web.UI.LiteralControl object to the ASP.NET page.
When you create a custom server control and want to render specific HTML or text to a client, you can improve the performance of the control by passing the value of the System.Web.UI.LiteralControl.Text property to the System.Web.UI.Control.Render(System.Web.UI.HtmlTextWriter) method rather than calling the LiteralControl.Render method. An System.Web.UI.HtmlTextWriter object that renders the content of the LiteralControl object to the requesting client.
LosFormatter class (System.Web.UI)
TrackViewState
Description
Serializes the view state for a Web Forms page. The limited object serialization (LOS) formatter is designed for highly compact ASCII format serialization. This class supports serializing any object graph, but is optimized for those containing strings, arrays, and hashtables. It offers second order optimization for many of the .NET primitive types.
This is a private format, and only needs to remain consistent for the lifetime of a Web request. You are not allowed to persist objects serialized with this formatter for any significant length of time.
LosFormatter
Example Syntax:
TrackViewState
Deserialize
Deserializes a LOS-formatted object from a System.IO.Stream object.
Return Value: Returns the deserialized object. The source of the object to be deserialized.
Deserialize
Deserializes a LOS formatted object from a string.
Return Value: Returns the deserialized object. The source of the object to be deserialized.
Deserialize
Deserializes a LOS-formatted object from a System.IO.TextReader object.
Return Value: Returns the deserialized object. The source of the object to be deserialized.
Serialize
Serializes the Web Forms view state value into a System.IO.Stream object. The object to serialize into. The view state information to pass.
Serialize
Serializes the view state value into a System.IO.TextWriter object. The object to serialize into. The view state information to pass.
ObjectConverter class (System.Web.UI)
ToString
Description
ObjectConverter
Example Syntax:
ToString
ConvertValue
ObjectTagBuilder class (System.Web.UI)
ToString
Description
ObjectTagBuilder
Example Syntax:
ToString
ControlType
FChildrenAsProperties
FIsNonParserAccessor
HasAspCode
ID
InDesigner
NamingContainerType
Parser
tagName
AppendLiteralString
AppendSubBuilder
Init
OutputCacheLocation enumeration (System.Web.UI)
ToString
Description
Specifies the valid values for the location of the output cache.
The values specified by this enumeration are used when you include an @ OutputCache directive in a .aspx file. These values set the cacheability of page output. For more information, see.
ToString
The output cache can be located on the browser client where the request originated, on a proxy server (or any other server) participating in the request, or on the server where the request was processed.
ToString
The output cache is located on the browser client where the request originated.
ToString
The output cache can be stored in any HTTP 1.1 cache-capable devices other than the origin server. This include proxy servers and the clietn that made the request.
ToString
The output cache is disabled for the requested page.
ToString
The output cache is located on the Web server where the request was processed.
Page class (System.Web.UI)
ToString
Description
Represents an .aspx file requested from a server that hosts an ASP.NET Web application.
The Page class is associated with files that have an .aspx extension. These files are compiled at runtime as a Page object and cached in server memory.
ToString
ToString
Page
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Page class.
The default constructor initializes all fields to their default values.
Application
ToString
Gets the Application object for the current Web request.
AspCompatMode
ToString
Sets a value indicating whether the page can be executed on a single-threaded apartment (STA) thread.
When set to true, this allows the page to be executed on a single-threaded apartment (STA) thread. This allows the page to call STA components, such as components developed with Visual Basic 6.0. Setting this to true also allows the page to call COM+1.0 components that require access to the unmanaged ASP built-in objects. These are accessible through the ASP ObjectContext object or the OnStartPage method.
AutoHandlers
Buffer
ToString
Description
Sets a value indicating whether the page output is buffered.
In most circumstances, do not set this property in code. Set the buffer attribute to true using the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
Cache
ToString
Gets the System.Web.Caching.Cache object associated with the application in which the page resides.
An application's Cache object allows you to store and retrieve arbitrary data on subsequent requests. The cache is not specifically associated with a page or user session. It is used primarily to enhance application performance. For more information, see.
ChildControlsCreated
ClientID
ClientTarget
ToString
Description
Gets or sets a value that allows you to override automatic detection of browser capabilities and to specify how a page renders for particular browser clients.
If you do not set this property, the System.Web.HttpBrowserCapabilities object associated with the System.Web.UI.Page.Request property reflects the capabilities of the client browser.
CodePage
ToString
Sets the code page identifier for the current System.Web.UI.Page.
In most circumstances, do not set this property in code. Set the CodePage attribute to the value you want using the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
ContentType
ToString
Sets the HTTP MIME type for the System.Web.HttpResponse object associated with the page.
In most circumstances, do not set this property in code. Set the ContentType attribute using the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
Context
ToString
Gets the System.Web.HttpContext object associated with the page.
This property provides programmatic access to the context the page runs in, including information about the request, response, session and application.
Controls
Culture
ToString
Description
Sets the culture ID for the System.Threading.Thread object associated with the page.
In most circumstances, do not set this property in code. Set the Culture attribute in the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
EnableViewState
ToString
Gets or sets a value indicating whether the page maintains its view state, and the view state of any server controls it contains, when the current page request ends.
EnableViewStateMac
ToString
Gets or sets a value indicating whether ASP.NET should run a machine authentication check (MAC) on the page's view state when the page is posted back from the client.
In most circumstances, do not set this property in code. Set the EnableViewStateMac attribute to true using the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
ErrorPage
ToString
Gets or sets the error page to which the requesting browser should be redirected in the event of an unhandled page exception.
Events
FileDependencies
ToString
Description
Sets an array of files that the current System.Web.HttpResponse object is dependent upon.
In most circumstances, do not set this property in code. Set the FileDependencies attribute to true using the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
HasChildViewState
ID
ToString
Description
Gets or sets an identifier for a particular instance of the System.Web.UI.Page class.
IsPostBack
ToString
Gets a value indicating whether the page is being loaded in response to a client postback, or if it is being loaded and accessed for the first time.
IsReusable
ToString
Page class can be cached/reused
IsTrackingViewState
IsValid
ToString
Description
Gets a value indicating whether page validation succeeded.
For this property to return true, all validation server controls in the System.Web.UI.Page.Validators property must validate successfully.
LCID
ToString
Sets the locale identifier for the System.Threading.Thread object associated with the page.
In most circumstances, do not set this property in code. Set the LCID attribute in the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
NamingContainer
Page
Parent
Request
ToString
Description
Gets the System.Web.HttpRequest object for the requested page.
The Request object contains information about current incoming HTTP request.
Response
ToString
Gets the System.Web.HttpResponse object associated with the System.Web.UI.Page. This object allows you to send HTTP response data to a client, and contains information about that response.
ResponseEncoding
ToString
Sets the encoding language for the current System.Web.HttpResponse object.
In most circumstances, do not set this property in code. Set the ResponseEncoding attribute to the value you want using the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
Server
ToString
Gets the Server object, which is an instance of the System.Web.HttpServerUtility class.
This property provides access to the frequently used System.Web.HttpServerUtility.HtmlEncode(System.String) and System.Web.HttpServerUtility.MapPath(System.String) methods, among others.
Session
ToString
Gets the current Session object provided by ASP.NET.
This property provides information about the current request's session. A Session object is maintained for each user that requests a page or document from an ASP.NET application. Variables stored in the Session object are not discarded when the user moves from page to page in the application; instead, these variables persist as long as the user is accessing pages in your application. For more information about session state, see.
Site
SmartNavigation
ToString
Description
Gets or sets a value indicating whether smart navigation is enabled.
In most circumstances, do not set this property in code. Set the SmartNavigation attribute to true in the directive in the .aspx file. When the page is requested, the dynamically generated class sets this property.
SupportAutoEvents
TemplateSourceDirectory
Trace
ToString
Description
Gets the System.Web.TraceContext object for the current Web request.
Tracing tracks and presents the execution details about a Web request. For trace data to be visible in a rendered page, you must enable tracing at the page or application level.
TraceEnabled
ToString
Sets a value indicating whether tracing is enabled for the System.Web.UI.Page.
In most circumstances, do not set this property in code. Set the Trace attribute to true in the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
TraceModeValue
ToString
Sets the mode in which trace statements are displayed on the page.
In most circumstances, do not set this property in code. Set the TraceMode attribute in the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
TransactionMode
ToString
Sets the level of transaction support for the page.
In most circumstances, do not set this property in code. Set the Transaction attribute in the directive in the .aspx file. When the page is requested, the dynamically generated class sets the property.
UICulture
ToString
Sets the UT ID for the System.Threading.Thread object associated with the page.
This property is a shortcut for System.Threading.Thread.CurrentThread. The culture is a property of the executing thread
UniqueID
User
ToString
Description
Gets information about the user making the page request.
An Iprincipal object represents the security context of the user on whose behalf the code is running, including that user's identity and any roles to which they belong.
Validators
ToString
Gets a collection of all validation controls contained on the requested page.
ViewState
ViewStateIgnoresCase
Visible
ToString
Description
Gets or sets a value indicating whether the System.Web.UI.Page object should be rendered.
AspCompatBeginProcessRequest
Initiates a request for Active Server Page (ASP) resources. This method is provided for compatibility with legacy ASP applications.
Do not call this method. An System.Web.HttpContext object with information about the current request. The callback method. Any extra data needed to process the request in the same manner as an ASP request.
AspCompatEndProcessRequest
Terminates a request for Active Server Page (ASP) resources. This method is provided for compatibility with legacy ASP applications.
Do not call this method. The ASP page generated by the request.
CreateHtmlTextWriter
Creates an System.Web.UI.HtmlTextWriter object to render the page's content.
Return Value: The specified System.Web.UI.HtmlTextWriter or System.Web.UI.Html32TextWriter object.
The object created is based on information from the System.Web.HttpBrowserCapabilities object associated with the page request. Usually, this object is an System.Web.UI.HtmlTextWriter or System.Web.UI.Html32TextWriter object. For derived pages, you can override this method to create a custom text writer Creates an System.Web.UI.HtmlTextWriter object to render the page's content. If the IsUplevel property is set to false, an Html32TextWriter object is created to render requests originating from downlevel browsers. For derived pages, you can override this method to create a custom text writer. The text writer to create.
DesignerInitialize
Performs any initialization of the instance of the System.Web.UI.Page class that is required by RAD designers. This method is only used at design time.
DeterminePostBackMode
Determines the type of request made for the Page class. This information is based on whether the page was posted back, and whether the GET or POST HTTP method was used for the request.
Return Value: If the postback used the POST method, the Form information is returned from the Context object. If the postback used the GET method, the query string information is returned. If the page is being requested for the first time, null is returned.
GetPostBackClientEvent
Obtains a reference to a client-side script function that causes, when invoked, a server postback to the form.
Return Value: The String that represents the client event. The server control that receives the client event postback. A System.String argument that is passed to the System.Web.UI.IPostBackEventHandler.RaisePostBackEvent(System.String) method.
GetPostBackClientHyperlink
Appends javascript: to the beginning of the return from a System.Web.UI.Page.GetPostBackEventReference(System.Web.UI.Control) call to allow hyperlink post back processing on the server.
Return Value: The name of the client-side function and the ID of the server control that processed the function and argument passed to the control. The server control to process the postback. The parameter passed to the server control.
GetPostBackEventReference
Obtains a reference to a client-side script function that causes, when invoked, the server to postback to the page.
Return Value: The text of the client-side function call that can be inserted into a client-side event handler. The server control to process the postback on the server.
GetPostBackEventReference
Obtains a reference to a client-side script function that causes, when invoked, the server to postback to the page. It also passes a parameter to the server control that performs the postback processing on the server.
Return Value: The text of the client-side function call that can be inserted into a client-side event handler. The server control to process the postback. The parameter passed to the server control.
GetTypeHashCode
Retrieves a hash code that is generated by Page objects that are generated at run time. This hash code is unique to the Page object's control hierarchy.
Return Value: The hash code generated at run time. The default is 0.
InitOutputCache
Initializes the output cache for the current page request.
You should not call this method. To enable and manipulate output caching for a page, use either the directive in the .aspx file, or the methods and properties of the System.Web.HttpCachePolicy class. The latter are accessible through Response.Cache syntax in the page's code-declaration block or code-behind file. For more information, see. An integer representing the amount of time that objects stored in the output cache are valid. A semi-colon separated list of headers that content from the output cache will vary by. A string that represents the Vary HTTP header. The location of the output cache as specified by the System.Web.UI.OutputCacheLocation enumeration. A semi-colon separated list of parameters, received by a GET or POST method, that content from the output cache will vary by.
IsClientScriptBlockRegistered
Determines if the client script block is registered with the page.
Return Value: Returns true if the script block is registered; otherwise, false.
Call this method before calling System.Web.UI.Page.RegisterClientScriptBlock(System.String,System.String) to avoid unnecessarily assembling the client-side script. This particularly important if the script requires a large amount of server resources to create. The string key of the client script to search for.
IsStartupScriptRegistered
Determines if the client startup script is registered with the System.Web.UI.Page object.
Return Value: true if the startup script is registered; otherwise, false.
Call this method before calling System.Web.UI.Page.RegisterStartupScript(System.String,System.String) to avoid unnecessarily assembling the client-side script. This particularly important if the script requires a large amount of server resources to create. The string key of the startup script to search for.
LoadPageStateFromPersistenceMedium
Loads any saved view-state information to the System.Web.UI.Page object. Override this method if you want to load the Page view state in anything other than a hidden field.
Return Value: The saved view state.
If you want to specify something other than hidden fields to save view state when using this method, you must also override the SaveStateToPersistenceMedium method.
MapPath
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
Return Value: The physical path associated with the virtual path. A System.String that represents the virtual path.
ProcessRequest
RaisePostBackEvent
Notifies the server control that caused postback that it should handle an incoming postback event.
The Page calls this when a post back occurs. This occurs in the page lifecycle after loading and change notification have completed, but before prerendering occurs. The ASP.NET server control that caused postback. This control must implement the IPostBackEventHandler interface. The post back argument.
RegisterArrayDeclaration
Declares a value that will be declared as an ECMAScript array declaration when the page renders. This can be used by script-based controls to declare themselves within an array so that a client script library can work with all the controls of the same type. The name of the array in which to declare the value. The value to place in the array.
RegisterClientScriptBlock
Allows ASP.NET server controls to emit client-side script blocks into the System.Web.UI.Page.
The client-side script is emitted jut after the opening tag of the Page object's
Top of Form element. The script block is emitted as you define to the output stream, so you must include both tags of the Bottom of Form
System.Web.UI.Design
Description
The System.Web.UI.Design namespace contains classes that can be used to extend design-time support for Web Forms.
CalendarDataBindingHandler class (System.Web.UI.Design)
Description
Provides a data binding handler for calendar data.
Constructors:
CalendarDataBindingHandler
Example Syntax:
Methods:
DataBindControl
Adds this data binding to the specified control. The designer host for the document that contains the control. The control to add this data binding to.
ColorBuilder class (System.Web.UI.Design)
ToString
Description
Launches a color editor that allows a user to select a color.
The System.Web.UI.Design.ColorBuilder.BuildColor(System.ComponentModel.IComponent,System.Windows.Forms.Control,System.String) method launches a user interface for selecting a color value.
BuildColor
Launches a color editor to build a color.
Return Value: The color value, represented as a string in an HTML color format, or null if the builder service could not be retrieved.
The returned string, if other than null, indicates a color in a valid HTML color format. Valid formats include named colors and color codes in RGB format (#RRGGBB). The component whose site is to be used to access design-time services. The control used to parent the picker window. The initial color to be shown in the picker window.
ControlDesigner class (System.Web.UI.Design)
ToString
Description
Provides a base class for Web server control designers.
ControlDesigner
Example Syntax:
ToString
Properties:
AllowResize
ToString
Gets a value indicating whether or not the control can be resized.
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
ToString
Description
Gets the designer view control object for the designer.
DesignTimeHtmlRequiresLoadComplete
ToString
Gets a value indicating whether the designer must have completed loading before the design time HTML can be used.
The default implementation returns false.
ID
ToString
Gets or sets the ID for the control designer.
InheritanceAttribute
Inherited
IsDirty
ToString
Description
Gets or sets a value indicating whether the Web server control has been marked as changed.
ReadOnly
ToString
Gets or sets a value indicating whether the control's associated design surface is set to read-only.
ShadowProperties
ShouldCodeSerialize
Verbs
CreatePlaceHolderDesignTimeHtml
Creates a simple HTML section for the control that can be used to display information related to the control at design-time when there is not enough information to display a meaningful representation of the control.
Return Value: A string containing place-holder design-time HTML.
This method returns a string containing HTML in a standard place-holder style that an empty control can display at design-time to provide some basic information about the control. The string that is returned contains the type of the control and its ID.
CreatePlaceHolderDesignTimeHtml
Creates a simple HTML section for the control, using the specified additional information, that can be used to display information related to the control at design-time when there is not enough information to display a meaningful representation of the control.
Return Value: A string containing place holder design-time HTML and the specified string.
This method returns a string containing HTML in a standard place-holder style that an empty control can display at design-time to provide some basic information about the control. The string that is returned contains the type of the control and its ID. A string conatining information to add to the HTML section.
GetDesignTimeHtml
Gets the HTML to be used for the design-time representation of the control.
Return Value: The design-time HTML for the control.
GetEmptyDesignTimeHtml
Gets the HTML to be used for the design-time representation of a blank control.
Return Value: The HTML used for the design-time representation of a blank control. This is the name of the component, by default.
The default behavior is to return a string containing the name of the component. This method is called by System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml when there is no design-time HTML.
GetErrorDesignTimeHtml
Gets the HTML to be used for the design-time representation of the control after an error has been encountered.
Return Value: The HTML for the specified exception. The exception that occurred.
GetPersistInnerHtml
Gets the persistable inner HTML.
Return Value: The persistable inner HTML.
Initialize
Initializes the designer with the specified component.
This method is called by the designer host to establish the component being designed. The control element being designed.
IsPropertyBound
Gets a value indicating whether the specified property is data-bound.
Return Value: true if the property is data bound; othwerise, false. The property to check for data binding.
OnBehaviorAttached
Called when the designer is attached to the behavior.
OnBindingsCollectionChanged
Called when the data bindings collection changes.
This method is called when the bindings collection has been changed by an external caller. In Visual Studio.NET, this method is called by the WebFormDataTab. The property to test for changes in its bindings collection.
OnComponentChanged
Called when the component changes.
This method is called when a property is changed. It allows the implementer to do any processing that may be needed after a property change. The object that is the source of the event. A System.ComponentModel.Design.ComponentChangedEventArgs object that provides data about the event.
OnControlResize
Called when the design-time control has been resized.
This method is typically only called by the design-time environment when a user action causes the control to be resized. This method may be called several times during a resize process to display the updated size of the control before the resize process is completed. The width and height properties of the control are updated before this method is called.
PreFilterProperties
RaiseResizeEvent
Raises the System.Web.UI.Design.ControlDesigner.OnControtResize event.
UpdateDesignTimeHtml
Updates the design-time HTML.
ControlParser class (System.Web.UI.Design)
UpdateDesignTimeHtml
Description
Provides methods for parsing the code for a control.
ParseControl
Initializes a new instance of the System.Web.UI.Design.ControlParser class using the specified designer host and control text.
Return Value: The Control that the specified text represents, or null if the parser could not build the control. The designer host for the document. The text of the code for the control.
ParseControl
Initializes a new instance of the System.Web.UI.Design.ControlParser class using the specified designer host, control text and directives.
Return Value: The Control that the specified text represents, or null if the parser could not build the control. The designer host of the document. The text of the code for the control. The directives to include in the code for the control.
ParseTemplate
Parses the specified text of a template.
Return Value: A new template based on the specified text. The designer host of the document. The text of the code for a template.
ParseTemplate
Parses the specified text of a template.
Return Value: A new template based on the specified text. The designer host of the document. The text of the code for a template. Any directives to add to the beginning of the code for the template.
ControlPersister class (System.Web.UI.Design)
ToString
Description
Provides helper functions for persisting Web server controls.
PersistControl
Gets a string of persistence data that can persist a control.
Return Value: A string that contains the information to persist about the control. The System.Web.UI.Control to persist.
PersistControl
Gets a string of persistence data that can persist a control.
Return Value: A string that contains the information to persist about the control. The System.Web.UI.Control to persist. The designer host for the control.
PersistControl
Persists a control using the specified text writer. The System.IO.TextWriter to use. The System.Web.UI.Control to persist.
PersistControl
Persists a control using the specified text writer. The System.IO.TextWriter to use. The System.Web.UI.Control to persist. The designer host for the control.
PersistInnerProperties
Gets a string of persistance data that can persist the inner properties of a control.
Return Value: A string that contains the information to persist about the inner properties of the control. The System.Web.UI.Control to persist. The designer host of the control.
PersistInnerProperties
Persists the inner properties of the control using the specified text writer. The System.IO.TextWriter to use. The System.Web.UI.Control to persist. The designer host of the control.
DataBindingCollectionConverter class (System.Web.UI.Design)
ToString
Description
Provides a type converter to convert data binding collections to various other representations.
DataBindingCollectionConverter
Example Syntax:
ToString
ConvertTo
Converts a data binding collection to the specified type.
Return Value: The object produced by the type conversion. An System.ComponentModel.ITypeDescriptorContext that indicates the component or control the data binding collection belongs to. A System.Globalization.CultureInfo that can be used to provide additional culture information. The object to convert. The type to convert to.
DataBindingCollectionEditor class (System.Web.UI.Design)
ToString
Description
Provides user interface for editing a collection of data bindings.
DataBindingCollectionEditor
Example Syntax:
ToString
EditValue
Edits the value of the specified data binding collection using the specified service provider and context.
Return Value: The new collection. An System.ComponentModel.ITypeDescriptorContext that identifies the component or control the collection belongs to. The System.IServiceProvider to use. The collection to edit.
GetEditStyle
Gets the editor stytle used by the System.Web.UI.Design.DataBindingCollectionEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object) method.
Return Value: A System.Drawing.Design.UITypeEditorEditStyle that specifies the editor edit style of the component or control. An System.ComponentModel.ITypeDescriptorContext that identifies the component or control to retrieve the edit style for.
DataBindingHandler class (System.Web.UI.Design)
ToString
Description
Provides a base class for a data binding handler.
DataBindingHandler
Example Syntax:
ToString
DataBindControl
Adds this data binding to the specified control. The designer host of the document. The control to data bind to.
DataBindingValueUIHandler class (System.Web.UI.Design)
ToString
Description
Provides a UI handler for data binding values.
DataBindingValueUIHandler
Example Syntax:
ToString
OnGetUIValueItem
Adds a data binding for the specified property and the specified value item list if the current control has data bindings and the current object does not already have a binding. An System.ComponentModel.ITypeDescriptorContext object that can provide additional context information. A System.ComponentModel.PropertyDescriptor that represents the property to add a data binding for. A list of items that have data bindings.
DataFieldConverter class (System.Web.UI.Design)
ToString
Description
Provides a type converter that can retrieve a list of data fields that are accessible through the current component's selected data source, and convert a data field name to string.
System.Web.UI.Design.DataFieldConverter provides methods that can be used to do the following: Convert a data field name string to string.
DataFieldConverter
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.DataFieldConverter class.
CanConvertFrom
Gets a value indicating whether the converter can convert an object of the specified source type to the native type of the converter.
Return Value: true if the converter can perform the conversion; otherwise, false.
This method returns true if the source type is a string. Otherwise, this method always returns false. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information. A System.Type that represents the type you wish to convert from.
ConvertFrom
Converts the specified object to the native type of the converter.
Return Value: An System.Object that represents the specified object after conversion.
Override this method to provide your own conversion requirements. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information. A System.Globalization.CultureInfo that can be used to support localization features. The System.Object to convert.
GetStandardValues
Gets the data fields present within the selected data source if information about them is available.
Return Value: A System.ComponentModel.TypeConverter.StandardValuesCollection listing the standard accessible data sources. An System.ComponentModel.ITypeDescriptorContext indicating the component or control to get values for.
GetStandardValuesExclusive
Gets a value indicating whether the collection of standard values returned from System.ComponentModel.TypeConverter.GetStandardValues is an exclusive list of all possible values.
Return Value: true if the System.ComponentModel.TypeConverter.StandardValuesCollection returned from System.ComponentModel.TypeConverter.GetStandardValues is an all exclusive list of all possible values; false if other values are possible.
If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then there are other valid values besides the list of standard values that System.ComponentModel.TypeConverter.GetStandardValues provides. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information.
GetStandardValuesSupported
Gets a value indicating whether the converter supports a standard set of values that can be picked from a list.
Return Value: true if System.ComponentModel.TypeConverter.GetStandardValues can be called to find a common set of values the object supports; otherwise, false. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information.
DataMemberConverter class (System.Web.UI.Design)
ToString
Description
Provides a type converter that can retrieve a list of data members that are accessible through the current component's selected data source, and convert a data member name to string.
System.Web.UI.Design.DataMemberConverter provides methods that can do the following: Convert a data member name string to string.
DataMemberConverter
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.DataFieldConverter class.
CanConvertFrom
Gets a value indicating whether the converter can convert an object of the specified source type to the native type of the converter.
Return Value: true if the converter can perform the conversion; otherwise, false.
Override this method to provide your own conversion requirements. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information. A System.Type that represents the type you wish to convert from.
ConvertFrom
Converts the specified object to the native type of the converter.
Return Value: An System.Object that represents the specified object after conversion.
Override this method to provide your own conversion requirements. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information. A System.Globalization.CultureInfo that can be used to support localization features. The System.Object to convert.
GetStandardValues
Gets the data members present within the selected data source, if information about them is available.
Return Value: A System.ComponentModel.TypeConverter.StandardValuesCollection listing the standard accessible data sources. An System.ComponentModel.ITypeDescriptorContext indicating the component or control to get values for.
GetStandardValuesExclusive
Gets a value indicating whether the collection of standard values returned from System.ComponentModel.TypeConverter.GetStandardValues is an exclusive list of all possible values.
Return Value: true if the System.ComponentModel.TypeConverter.StandardValuesCollection returned from System.ComponentModel.TypeConverter.GetStandardValues is an exclusive list of possible values; false if other values are possible.
If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then there are other valid values besides the list of standard values that System.ComponentModel.TypeConverter.GetStandardValues provides. An System.ComponentModel.ITypeDescriptorContext that provides a format context.
GetStandardValuesSupported
Gets a value indicating whether the converter supports a standard set of values that can be picked from a list.
Return Value: true if System.ComponentModel.TypeConverter.GetStandardValues should be called to find a common set of values the object supports; otherwise, false. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information.
DataSourceConverter class (System.Web.UI.Design)
ToString
Description
Provides a type converter that can retrieve a list of data sources accessible to the current component, and convert a data source name to string.
System.Web.UI.Design.DataSourceConverter provides methods that can be used to do the following: Convert a data source name string to string.
DataSourceConverter
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.DataSourceConverter class.
CanConvertFrom
Gets a value indicating whether the converter can convert an object of the specified source type to the native type of the converter.
Return Value: true if the converter can perform the conversion; otherwise, false.
Override this method to provide your own conversion requirements. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information. A System.Type that represents the type you wish to convert from.
ConvertFrom
Converts the specified object to the native type of the converter.
Return Value: An System.Object that represents the specified object after conversion.
Override this method to provide your own conversion requirements. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information. The System.Globalization.CultureInfo that can be used to support localization features. The System.Object to convert.
GetStandardValues
Gets the standard data sources accessible to the control.
Return Value: A System.ComponentModel.TypeConverter.StandardValuesCollection listing the standard accessible data sources. An System.ComponentModel.ITypeDescriptorContext indicating the component or control to get values for.
GetStandardValuesExclusive
Gets a value indicating whether the collection of standard values returned from System.ComponentModel.TypeConverter.GetStandardValues is an exclusive list of all possible values.
Return Value: true if the System.ComponentModel.TypeConverter.StandardValuesCollection returned from System.ComponentModel.TypeConverter.GetStandardValues is an exclusive list of all possible values; false if other values are possible.
If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then there are other valid values besides the list of standard values that System.ComponentModel.TypeConverter.GetStandardValues provides. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information.
GetStandardValuesSupported
Gets a value indicating whether the converter supports a standard set of values that can be picked from a list.
Return Value: true if System.ComponentModel.TypeConverter.GetStandardValues should be called to find a common set of values the object supports; otherwise, false. An System.ComponentModel.ITypeDescriptorContext that can be used to gain A additional context information.
DesignTimeData class (System.Web.UI.Design)
ToString
Description
Provides helper methods that can be used by control designers to generate sample data for use in design time databinding.
ToString
CreateDummyDataTable
Creates a datatable that contains sample data.
Return Value: A new System.Data.DataTable that contains 3 columns of type string.
CreateSampleDataTable
Creates a sample datatable with the same schema as the supplied datasource.
Return Value: A sample data table that contains dummy data in the format of the specified data source, or a default dummy data table if the specified data source contained no data columns. A data source with the schema to use as the format for the sample datatable.
GetDataFields
Gets the data fields of the specified data source.
Return Value: A System.ComponentModel.PropertyDescriptorCollection that represents the data fields of the speciifed data source. The data source to retrieve the data fields of.
GetDataMember
Gets the specified data member from the specified data source.
Return Value: The specified data member from the specified data source, if it exists.
This method searches the specified data source for the specified data member. If the dataMember property is null, the first item in the specified data source is returned. The data source that contains the member to retrieve. The data member to retrieve.
GetDataMembers
Gets the data members of the specified data source.
Return Value: A string array that represents the data members of the specified data source. The data source to retrieve the members of.
GetDesignTimeDataSource
Adds sample rows to the specified data table and returns the updated table.
Return Value: A live data source for use at design time. The table that defines the shape of the data source. Sample rows are added to this table. The minimum number of rows of sample data that the data source will contain.
GetSelectedDataSource
Gets the specified data source.
Return Value: The data source object, or null if the data source, specified component's site, or the container of the data source could not be accessed. The component that contains the data source. The data source to retrieve.
GetSelectedDataSource
Gets the specified data member of the specified data source.
Return Value: The data member, or null if the data source could not be accessed. The component that contains the data source. The data source to retrieve. The data member to retrieve.
HtmlControlDesigner class (System.Web.UI.Design)
ToString
Description
Provides basic design-time functionality for ASP.NET server controls.
HtmlControlDesigner
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.HtmlControlDesigner class.
AssociatedComponents
Behavior
ToString
Description
Gets or sets the DHTML behavior associated with the designer instance.
Component
DataBindings
ToString
Description
Gets or sets the data bindings for the current control.
DesignTimeElement
ToString
Gets the base Web Forms designer associated to the ASPX document.
InheritanceAttribute
Inherited
ShadowProperties
ShouldCodeSerialize
ToString
Description
Indicates whether a field declaration for the control should be created in the code-behind file for the current design document.
Verbs
Dispose
Releases the unmanaged resources used by the System.Web.UI.Design.HtmlControlDesigner and optionally releases the managed resources.
This method is called by the public Dispose( ) method and the System.Object.Finalize method. true to release both managed and unmanaged resources; false to release only unmanaged resources.
Description
Initializes the designer and sets the component for design.
System.Web.UI.Design.ControlDesigner.Initialize(System.ComponentModel.IComponent) should be called by the designer host to initialize the designer. The control element for design.
OnBehaviorAttached
Notification that is called when a behavior is attached to the designer.
OnBehaviorDetaching
Notification that is called when a behavior is detatched from the designer.
OnBindingsCollectionChanged
Provides a method that can be used to indicate when a data binding has been changed.
This method should be called by a control designer after it has made a change to the data bindings for the control. The name of the property that has been changed.
OnSetParent
Notification that is called when the associated control is parented.
PreFilterEvents
Allows a designer to filter the set of member events that the component it is designing will expose through a System.ComponentModel.TypeDescriptor object.
If you are overriding this method you should call the base implementation before you perform your own filtering. When overriding this method, it should return the augmented set of attributes. If the method does not modify any attributes, it may just return a reference to its input parameter. If you do make a change to the attributes, you must create a new array. The set of events for the component.
PreFilterProperties
Allows a designer to filter the set of member attributes that the component it is designing will expose through a System.ComponentModel.TypeDescriptor object.
If you are overriding this method you should call the base implementation before you perform your own filtering. When overriding this method, it should return the augmented set of attributes. If the method does not modify any attributes, it may just return a reference to its input parameter. If you do make a change to the attributes, you must create a new array. The set of properties to filter for the component.
HtmlIntrinsicControlDesigner class (System.Web.UI.Design)
ToString
Description
Provides a base designer for all intrinsic HTML controls.
Intrinsic HTML controls are defined within, or derived from classes defined within, the System.Web.UI.HtmlControls.HtmlControl namespace.
HtmlIntrinsicControlDesigner
Example Syntax:
ToString
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
InheritanceAttribute
Inherited
ShadowProperties
ShouldCodeSerialize
Verbs
HyperLinkDataBindingHandler class (System.Web.UI.Design)
ToString
Description
Provides a data binding handler for a hyperlink property.
HyperLinkDataBindingHandler
Example Syntax:
ToString
DataBindControl
Adds this data binding to the specified control. The designer host for the document that contains the control. The control to add this data binding to.
IControlDesignerBehavior interface (System.Web.UI.Design)
ToString
Description
Provides an interface to provide a behavior for a control designer.
DesignTimeElementView
ToString
Gets or sets the design-time view control object for the designer.
DesignTimeHtml
ToString
Gets or sets the design-time HTML for the designer's control.
OnTemplateModeChanged
Raises the TemplateModeChanged event.
Raising an event invokes the event handler through a delegate. For more information, see.
IDataSourceProvider interface (System.Web.UI.Design)
OnTemplateModeChanged
Description
Provides an interface that enables access to a data source.
A class that can provide a data source can implement this interface to enable access to its data source by objects that use the System.Web.UI.Design.IDataSourceProvider interface.
GetResolvedSelectedDataSource
When implemented in a derived class, gets the selected data member from the selected data source.
Return Value: The selected data member from the selected data source.
GetSelectedDataSource
When implemented in a derived class, gets a reference to the data source that this data source provider provides.
Return Value: The data source that this data source provider provides.
IHtmlControlDesignerBehavior interface (System.Web.UI.Design)
GetSelectedDataSource
Description
Provides an interface to provide a behavior for an Interactive HTML control designer.
Designer
GetSelectedDataSource
Gets or sets the designer that this behavior is associated with.
DesignTimeElement
GetSelectedDataSource
Gets the element that this designer is designing.
GetAttribute
Gets the specified attribute.
Return Value: The attribute that was retrieved. The attribute to retrieve. true if the attribute syntax is case-insensitive; otherwise, false.
GetStyleAttribute
Gets the specified style attribute.
Return Value: The style attribute that was retrieved. The style attribute to retrieve. true if the attribute is a design-time only attribute; otherwise, false. true if the attribute syntax is case-insensitive; otherwise, false.
RemoveAttribute
Removes the specified attribute. The attribute to remove. true if the attribute syntax is case-insensitive; otherwise, false.
RemoveStyleAttribute
Removes the specified style attribute. The style attribute to remove. true if the attribute is a design-time only attribute; otherwise, false. true if the attribute syntax is case-insensitive; otherwise, false.
SetAttribute
Sets the specified attribute to the specified object. The attribute to set. The object on which to set the attribute. true if the attribute syntax is case-insensitive; otherwise, false.
SetStyleAttribute
Sets the specified style attribute to the specified object. The attribute to set. true if the attribute is a design-time only attribute; otherwise, false. The object to set the attribute on. true if the attribute syntax is case-insensitive; otherwise, false.
ImageUrlEditor class (System.Web.UI.Design)
SetStyleAttribute
Description
Provides a user interface for selecting a URL.
This class extends System.Web.UI.Design.UrlEditor and provides a caption and filter property.
ImageUrlEditor
Example Syntax:
SetStyleAttribute
Caption
SetStyleAttribute
Gets the caption for the editor.
Filter
SetStyleAttribute
Gets the filter to use for filtering the file list.
Options
ITemplateEditingFrame interface (System.Web.UI.Design)
ToString
Description
Provides an interface to manage a template editing area.
ControlStyle
ToString
Gets or sets the style for the editing frame.
InitialHeight
ToString
Gets or sets the initial height for the control.
InitialWidth
ToString
Gets or sets the initial width for the control.
Name
ToString
Gets or sets the name for this editing frame.
TemplateNames
ToString
Gets or sets a set of names of templates to use.
TemplateStyles
ToString
Gets or sets the template styles for this control.
Verb
ToString
Gets or sets the verb to invoke when editing the template.
Close
Closes the control and saves any changes to the control if the specified value is true. true if any changes to the document should be changed; otherwise, false.
Open
Opens and displays the control.
Resize
Resizes the control to the specified width and height. The new width for the control. The new height for the control.
Save
Saves any changes to the document.
UpdateControlName
Changes the name for the control to the specified name. The new name for the control.
ITemplateEditingService interface (System.Web.UI.Design)
UpdateControlName
Description
Provides services for editing templated control templates at design-time.
SupportsNestedTemplateEditing
UpdateControlName
Indicates whether the service supports nested template editing.
This property indicates whether a template editor can be invoked from a parent template editor for a component of the parent template editor's templated control. This is called nested template editing, because a template editor is launched for a component of a control for which a template editor is already operating.
CreateFrame
Creates a new template editing frame for the specified System.Web.UI.Design.TemplatedControlDesigner, using the specified name and templates.
Return Value: The new System.Web.UI.Design.ITemplateEditingFrame. The designer that will use the template editing frame. The name of the editing frame that will be displayed on the frame. Typically this is the same as the System.ComponentModel.Design.DesignerVerb.Text property used as the menu text for the System.Web.UI.Design.TemplateEditingVerb that is invoked to create the frame. The names of the templates that the template editing frame will contain.
CreateFrame
Creates a new template editing frame for the specified System.Web.UI.Design.TemplatedControlDesigner, using the specified name, template names, control style, and template styles.
Return Value: The new System.Web.UI.Design.ITemplateEditingFrame. The designer that will use the template editing frame. The name of the editing frame that will be displayed on the frame. Typically this is the same as the System.ComponentModel.Design.DesignerVerb.Text property used as the menu text for the System.Web.UI.Design.TemplateEditingVerb that is invoked to create the frame. The names of the templates that the template editing frame will contain. The control style for the editing frame. The template styles for the editing frame.
GetContainingTemplateName
Gets the name of the parent template.
Return Value: The name of the parent template. The control to get the name of the parent template of.
IWebFormReferenceManager interface (System.Web.UI.Design)
GetContainingTemplateName
Description
Provides an interface that can be used to manage references stored by a Web Form.
GetObjectType
Gets the type of the specified object.
Return Value: The System.Type of the object, if it could be resolved. The tag prefix for the type. The name of the type.
GetRegisterDirectives
Gets the register directives.
Return Value: The register directives for the project.
GetTagPrefix
Gets the tag prefix.
Return Value: The tag prefix for the specified object type, if it could be located. The type of the object.
IWebFormsBuilderUIService interface (System.Web.UI.Design)
GetTagPrefix
Description
Provides methods to launch specific user interfaces for building properties at design-time.
BuildColor
Launches an editor to build a color property.
Return Value: A string that represents the color that was selected. The control that contains the property to build. The initial color for the editor to pre-select.
BuildUrl
Launches an editor to build a URL property.
Return Value: A string that contains the URL returned by the System.Web.UI.Design.UrlBuilder. The control that contains the property to build. The initial URL to display in the selection interface. The base URL to display in the selection interface. A caption that presents a message in the selection interface. A filter for the types of files listed in the selection interface. The options for the System.Web.UI.Design.UrlBuilder to use.
IWebFormsDocumentService interface (System.Web.UI.Design)
BuildUrl
Description
Provides methods to access services for tracking the loading state of a web forms document, handling events at load time, accessing a document's location, managing a document's undo service, and setting a new selection within the document.
DocumentUrl
BuildUrl
Gets or sets the URL at which the document is located.
IsLoading
BuildUrl
Indicates whether the document service is currently loading.
BuildUrl
Occurs when the service has finished loading.
This event provides an opportunity to perform operations immediately after loading has completed. Events that should occur at load time can be registered as event handlers for this event.
CreateDiscardableUndoUnit
Creates a discardable undo unit.
Return Value: The new discardable undo unit.
DiscardUndoUnit
Discards the specified undo unit. The undo unit to discard.
EnableUndo
Enables the ability to undo actions that occur within undoable action units or transactions. true if actions should be undoable; otherwise, false.
UpdateSelection
When implemented in a derived class, updates the current selection.
When implemented in a derived class, this method updates the current selection.
ReadWriteControlDesigner class (System.Web.UI.Design)
UpdateSelection
Description
Provides design-time functionality for read/write server controls.
ReadWriteControlDesigner
Example Syntax:
UpdateSelection
Initializes an instance of the System.Web.UI.Design.ReadWriteControlDesigner class.
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
MapPropertyToStyle
Maps a property, including description and value, to an Interactive HTML style.
Return Value: This method must be overridden in a derived class to implement the designer. The name of the property to map. The value of the property.
OnBehaviorAttached
Provides notification that is raised upon a behavior being attached to the designer.
OnComponentChanged
Represents the method that will handle the System.ComponentModel.Design.IComponentChangeService.ComponentChanged event of the System.ComponentModel.Design.IComponentChangeService.
The System.ComponentModel.Design.IComponentChangeService.ComponentChanged event occurs after a property has been changed. This delegate allows implementors to do any post-processing that may be needed after a property change. The object sending the event. The event object used when raising a System.ComponentModel.Design.IComponentChangeService.ComponentChanged event notification.
TemplatedControlDesigner class (System.Web.UI.Design)
UpdateDesignTimeHtml
Description
Provides design-time functionality for template-based server controls.
TemplatedControlDesigner
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of the System.Web.UI.Design.TemplatedControlDesigner class.
ActiveTemplateEditingFrame
UpdateDesignTimeHtml
Gets the active template editing frame.
AllowResize
AssociatedComponents
Behavior
CanEnterTemplateMode
UpdateDesignTimeHtml
Description
Indicates whether or not this designer will allow the viewing or editing of templates. This property is read-only.
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
HidePropertiesInTemplateMode
UpdateDesignTimeHtml
Description
Indicates whether the properties of the control will be hidden when the control is placed into template editing mode.
The System.Web.UI.Design.ControlDesigner.ID property is never hidden.
ID
InheritanceAttribute
Inherited
InTemplateMode
UpdateDesignTimeHtml
Description
Indicates whether or not the designer document is in template mode.
A document is in template mode when a template is currently being viewed or edited in the forms designer.
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
CreateTemplateEditingFrame
Creates a template editing frame for the specified verb.
Return Value: The new template editing frame. The template editing verb to create a template editing frame for.
Dispose
Releases the unmanaged resources used by the System.Web.UI.Design.TemplatedControlDesigner and optionally releases the managed resources.
This method is called by the public Dispose( ) method and the System.Object.Finalize method. true to release both managed and unmanaged resources; false to release only unmanaged resources.
EnterTemplateMode
Opens a particular template frame object for editing in the designer.
If already in template mode and editing a different template frame, this method calls System.Web.UI.Design.TemplatedControlDesigner.ExitTemplateMode(System.Boolean,System.Boolean,System.Boolean) to save all its templates and close that frame. The template editing frame object to open in the designer.
ExitTemplateMode
Closes the currently active template editing frame after saving any relevant changes. true when switching from one template editing frame to another, otherwise false. true if this designer is nested (one or more levels) within another control whose designer is also in template editing mode; otherwise false. true if templates should be saved on exit; otherwise, false.
GetCachedTemplateEditingVerbs
Gets the cached template editing verbs.
Return Value: An array of System.Web.UI.Design.TemplateEditingVerb objects, if any.
GetPersistInnerHtml
Gets the HTML to be persisted for the content present within the associated server control runtime.
Return Value: The persistable inner HTML.
GetTemplateContainerDataItemProperty
Gets the data item property of the template's container.
Return Value: A string representing the data. The name of the template.
GetTemplateContainerDataSource
Gets the data source of the template's container.
Return Value: The data source of the container of the specified template. The name of the template.
GetTemplateContent
Gets the template's content.
Return Value: The content of the template. The template editing frame to retrieve the content of. The name of the template. A boolean variable that will be set to true if the template's content can be edited, or false if the content is read-only.
GetTemplateEditingVerbs
Gets the template editing verbs available to the designer.
Return Value: The template editing verbs available to the designer.
GetTemplateFromText
Creates a template from the specified text.
Return Value: An System.Web.UI.ITemplate from the specified text. The text to retrieve a template from.
GetTemplatePropertyParentType
Gets the type of the parent of the template property.
Return Value: The type of the object that has the template property. The name of the template to return the type of the parent for.
GetTextFromTemplate
Gets a string of text that represents the specified template.
Return Value: A string that represents the specified template. The System.Web.UI.ITemplate to convert to text.
OnBehaviorAttached
Notification that is called when the behavior is attached to the designer.
OnComponentChanged
Delegate to handle the component changed event.
This is called after a property has been changed. It allows the implementor to do any post-processing that may be needed after a property change. The object sending the event. A System.ComponentModel.Design.ComponentChangedEventArgs that provides data for the event.
OnSetParent
Notification that is called when the associated control is parented.
OnTemplateModeChanged
Provides notification and handles processing that should occur when the template mode is changed.
PreFilterProperties
Allows a designer to filter the set of member attributes the component it is designing will expose through a System.ComponentModel.TypeDescriptor object.
Return Value: The augmented set of attributes. If the method does not modify any attributes, it may just return a reference to its input parameter. If you do make a change to the attributes, you must create a new array.
This method is called immediately before its corresponding “Post” method. If you are overriding this method you should call the base implementation before you perform your own filtering. The member attributes for component.
SaveActiveTemplateEditingFrame
Saves the active template editing frame.
SetTemplateContent
Sets the specified template's content to the specified content. The template editing frame to provide content for. The name of the template. The content to set for the template.
UpdateDesignTimeHtml
Updates the design-time HTML.
This method should be called to refresh the design-time display if the template frames have been changed without calling methods that update the design-time HTML automatically.
TemplateEditingService class (System.Web.UI.Design)
UpdateDesignTimeHtml
TemplateEditingService
Example Syntax:
UpdateDesignTimeHtml
SupportsNestedTemplateEditing
UpdateDesignTimeHtml
CreateFrame
CreateFrame
Dispose
Finalize
GetContainingTemplateName
TemplateEditingVerb class (System.Web.UI.Design)
ToString
Description
Represents a designer verb that creates a template editing frame, and can only be invoked by a template editor.
TemplateEditingVerb
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.TemplateEditingVerb class. The text to show for this verb on a menu. An optional integer value that can be used by a designer; typically to indicate the index of the verb within a set of verbs. The designer that can use this verb.
Checked
CommandID
Enabled
Index
ToString
Description
Gets or sets the index, or other user data, for this verb.
This property is sometimes used to store the index of each verb in a set of verbs. When implementing a custom designer, this property can be used to store integer data in a custom defined manner.
OleStatus
Supported
Text
Visible
Dispose
Releases all resources used by the System.Web.UI.Design.TemplateEditingVerb.
Calling System.Web.UI.Design.TemplateEditingVerb.Dispose allows the resources used by the System.Web.UI.Design.TemplateEditingVerb to be reallocated for other purposes. For more information about System.Web.UI.Design.TemplateEditingVerb.Dispose, see.
Dispose
Releases the unmanaged resources used by the System.Web.UI.Design.TemplateEditingVerb and optionally releases the managed resources.
This method is called by the public Dispose( ) method and the System.Object.Finalize method. true to release both managed and unmanaged resources; false to release only unmanaged resources.
Finalize
TextControlDesigner class (System.Web.UI.Design)
ToString
Description
Provides design-time support for the ASP.NET System.Web.UI.WebControls.Label and System.Windows.Forms.HyperLink server controls.
TextControlDesigner
Example Syntax:
ToString
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
GetDesignTimeHtml
Gets the HTML that is used to represent the associated control at design time.
Return Value: The HTML used to represent the control at design-time.
GetPersistInnerHtml
Gets the HTML to persist for the inner tags of the control.
Return Value: The HTML for the tags of the control.
Initialize
Initializes this designer with the specified component. The component for this designer to design.
TextDataBindingHandler class (System.Web.UI.Design)
UpdateDesignTimeHtml
Description
Provides a data binding handler for a text property of a control.
TextDataBindingHandler
Example Syntax:
UpdateDesignTimeHtml
DataBindControl
Adds this data binding to the specified control. The designer host for the document that contains the control. The control to add this data binding to.
UrlBuilder class (System.Web.UI.Design)
ToString
Description
Launches a URL editor that allows a user to select a URL.
The System.Web.UI.Design.UrlBuilder.BuildUrl(System.ComponentModel.IComponent,System.Windows.Forms.Control,System.String,System.String,System. String) method launches a user interface for selecting a URL.
BuildUrl
Launches the Url Picker to build a Url property.
Return Value: The Url returned from the Url Picker. The component whose site is to be used to access design-time services. The control used to parent the picker window. The initial Url to be shown in the picker window. The caption of the picker window. The filter for selecting files in the picker window.
BuildUrl
Launches the Url Picker to build a Url property using the specified System.Web.UI.Design.UrlBuilderOptions.
Return Value: The Url returned from the Url Picker. The component whose site is to be used to access design-time services. The control used to parent the picker window. The initial Url to be shown in the picker window. The caption of the picker window. The filter for selecting files in the picker window. A System.Web.UI.Design.UrlBuilderOptions indicating the options for Url selection.
UrlBuilderOptions enumeration (System.Web.UI.Design)
ToString
Description
Defines identifiers for settings for a System.Web.UI.Design.UrlBuilder.
ToString
Build a URL that references a path relative to the current path, rather than one that consists of a fully qualified, absolute path reference URL.
ToString
Use no additional options for the System.Web.UI.Design.UrlBuilder.
UrlEditor class (System.Web.UI.Design)
ToString
Description
Provides a user interface for selecting a URL.
UrlEditor
Example Syntax:
ToString
Caption
ToString
Gets the caption for the URL.
Filter
ToString
Gets or sets the file extensions to filter the file list for.
Options
ToString
Gets the options for a URL builder to use.
EditValue
Edits the value of the specified object using the editor style provided by the System.Web.UI.Design.UrlEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext) method.
Return Value: The new value of the object. If the value of the object hasn't changed, this should return the same object it was passed.
A service provider is provided so that any required editing services can be obtained. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information. A service provider object through which editing services may be obtained. An instance of the value being edited.
GetEditStyle
Gets the editing style of the System.Web.UI.Design.UrlEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object) method.
Return Value: One of the System.Drawing.Design.UITypeEditorEditStyle values indicating the provided editing style. If the method is not supported, this will return System.Drawing.Design.UITypeEditorEditStyle.None. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information.
UserControlDesigner class (System.Web.UI.Design)
ToString
Description
Provides design-time support for web user controls.
UserControlDesigner
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.UserControlDesigner class.
AllowResize
ToString
Indicates whether all user controls are resizable.
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
ToString
Description
Indicates whether this designer should add a field declaration for the control in the code-behind file for the current design document.
Verbs
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
GetPersistInnerHtml
Gets the inner HTML that is persisted for the control.
Return Value: The content to be persisted from within the control's tags.
WebControlToolboxItem class (System.Web.UI.Design)
UpdateDesignTimeHtml
Description
Provides a base class for a Web server control System.Drawing.Design.ToolboxItem.
WebControlToolboxItem
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of the System.Web.UI.Design.WebControlToolboxltem class.
The display name will be a short version of the type name.
WebControlToolboxItem
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of the System.Web.UI.Design.WebControlToolboxltem class. The fully qualified type name of the tool for this toolbox item
AssemblyName
Bitmap
DisplayName
Filter
Locked
TypeName
CreateComponentsCore
Creates objects from each Type contained in this System.Drawing.Design.ToolboxItem, and adds them to the specified designer.
Return Value: An array of created System.ComponentModel.IComponent objects.
You can override this method to alter the way components are created. The System.ComponentModel.Design.IDesignerHost to use to create the components.
Deserialize
GetToolAttributeValue
Gets the value of the attribute of the specified type of the toolbox item.
Return Value: The value of the specified type of attribute.
The default implementation will throw an ArgumentException if the attributeType parameter is anything other than a PersistChildrenAttribute. The designer host for the current design document. The type of attribute to retrieve the value of.
GetToolHtml
Gets the HTML associated with the tool.
Return Value: The HTML associated with the tool. The designer host for the current design document.
GetToolType
Gets the type of this toolbox item.
Return Value: The type of this toolbox item. The designer host for the current design document.
Initialize
Initializes this toolbox item. The type of this Web server control toolbox item.
Serialize
XmlFileEditor class (System.Web.UI.Design)
ToString
Description
Provides a user interface for selecting an XML File.
XmlFileEditor
Example Syntax:
ToString
EditValue
Edits the value of the specified object using the specified service provider and context.
Return Value: The new value of the object. If the value of the object hasn't changed, this method should return the same object it was passed.
A service provider is provided so that any required editing services can be obtained. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information. A service provider object through which editing services may be obtained. An instance of the value being edited.
GetEditStyle
Gets the editor style used by the System.Web.UI.Design.XmlFileEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object) method.
Return Value: An value indicating the provided editing style. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information.
XmlUrlEditor class (System.Web.UI.Design)
ToString
Description
Provides a user interface for editing an URL embedded in XML.
XmlUrlEditor
Example Syntax:
ToString
Caption
ToString
Gets or sets the caption for the URL.
Filter
ToString
Gets or sets the file extensions to filter the file list for.
Options
ToString
Gets the options for a URL builder to use.
XslUrlEditor class (System.Web.UI.Design)
ToString
Description
Provides a user interface for selecting an XSL file.
XslUrlEditor
Example Syntax:
ToString
Caption
ToString
Gets or sets the caption for the URL.
Filter
ToString
The System.Web.UI.Design.WebControls namespace contains classes that can be used to extend design-time support for Web server controls.
AdRotatorDesigner class (System.Web.UI.Design.WebControls)
Description
Provides design-time support for the System.Web.UI.WebControls.AdRotator Web server control.
Constructors:
AdRotatorDesigner
Example Syntax:
Properties:
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
Methods:
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
BaseDataListComponentEditor class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides a base component editor class for the Web Forms System.Web.UI.WebControls.DataGrid and System.Web.UI.WebControls.DataList Web server controls.
BaseDataListComponentEditor
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of the System.Web.UI.Design.WebControls.BaseDataListComponentEditor class. The index of the initial page to display.
EditComponent
Edits the specified component using the specified context descriptor and parent window.
Return Value: true if editing the component succeeded; otherwise, false. An System.ComponentModel.ITypeDescriptorContext that can be used to gain additional context information. The component to edit. The parent window.
GetInitialComponentEditorPageIndex
Gets the index of the initial component editor page.
Return Value: The index of the initial page.
BaseDataListDesigner class (System.Web.UI.Design.WebControls)
ToString
Description
Provides a base designer class for the System.Web.UI.WebControls.DataList Web server control.
BaseDataListDesigner
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.WebControls.BaseDataListDesigner class.
ActiveTemplateEditingFrame
AllowResize
AssociatedComponents
Behavior
CanEnterTemplateMode
Component
DataBindings
DataKeyField
ToString
Description
Gets or sets the value of the control's data key field.
The System.Web.UI.Design.WebControls.BaseDataListDesigner.DataKeyField property of this designer gets or sets the System.Web.UI.WebControls.DataList.DataKeyField property of the System.Web.UI.WebControls.DataList control that this designer is editing.
DataMember
ToString
Gets or sets the value of the control's data member field.
The System.Web.UI.Design.WebControls.BaseDataListDesigner.DataMember property of this designer gets or sets the System.Web.UI.WebControls.DataList.DataMember property of the System.Web.UI.WebControls.DataList control that this designer is editing.
DataSource
ToString
Gets or sets the value of the control's data source property.
The System.Web.UI.Design.WebControls.BaseDataListDesigner.DataSource property of this designer gets or sets the System.Web.UI.WebControls.DataList.DataSource property of the System.Web.UI.WebControls.DataList control that this designer is editing.
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ToString
Description
Indicates whether loading must have completed to display the design-time HTML.
If this property is set to true, the control will not be displayed until the entire load has completed.
HidePropertiesInTemplateMode
ID
InheritanceAttribute
Inherited
InTemplateMode
IsDirty
I ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
ToString
Description
Gets or sets the collection of verbs available to this designer.
Dispose
Releases the unmanaged resources used by the System.Web.UI.Design.WebControls.BaseDataListDesigner and optionally releases the managed resources.
This method is called by the public Dispose( ) method and the System.Object.Finalize method. true to release both managed and unmanaged resources; false to release only unmanaged resources.
GetDesignTimeDataSource
Gets a set of sample data that matching the schema of the selected data source.
Return Value: A live data source for use at design-time. The minimum rows of sample data that the data source data should contain. A boolean variable that will be set to true if the returned data source contains dummy data, or false if the data source was populated with data from an actual data source.
GetDesignTimeDataSource
Gets a set of sample data that matches the schema of the selected data source.
Return Value: A live data source for use at design-time. The data source that will be used as a template for the format of the data. The minimum number of rows of sample data that the data source data should contain. A boolean variable that will be set to true if the returned data source contains dummy data, or false if the data source was populated with data from an actual data source.
GetResolvedSelectedDataSource
Gets the data member that is currently selected within the data source currently bound to the control.
Return Value: The currently selected data member, or null 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.
GetSelectedDataSource
Gets the selected data source component from the component's container.
Return Value: The selected data source, or null if a data source is not found, or if a data source with the same name does not exist.
GetTemplateContainerDataSource
Gets the template's container's data source.
Return Value: An object that implements System.Collections.IEnumerable and contains the data source or data sources available to the template's container. The name of the template to retrieve the data source for.
Initialize
Initializes the designer with the System.Web.UI.WebControls.DataGrid control that this instance of the designer is associated with. The associated System.Web.UI.WebControls.DataGrid control.
InvokePropertyBuilder
Invokes the property builder beginning with the specified page. The page to begin with.
OnAutoFormat
Represents the method that will handle the AutoFormat event. The source of the event. An System.EventArgs object that provides data about the event.
OnComponentChanged
Represents the method that will handle the component change event. The source of the event. The System.ComponentModel.Design.ComponentChangedEventArgs that provides data about the event.
OnDataSourceChanged
Raises the DataSourceChanged event.
OnPropertyBuilder
Represents the method that will handle the property builder event. The source of the event. An System.EventArgs object that provides data about the event.
OnStylesChanged
Provides a method that can be overrriden to implement functionality that should occur when a style of the control has been changed.
This method can serve as notification that a style of the control has changed.
OnTemplateEditingVerbsChanged
Provides a method that can be overrriden to implement functionality that should occur when the designer's template editing verbs have changed.
This method can serve as notification that the designer's template editing verbs have changed.
PreFilterProperties
Filters the properties exposed through a System.ComponentModel.TypeDescriptor and replaces the runtime DataSource property descriptor with a design-time data source. The set of properties to filter.
BaseValidatorDesigner class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides design-time support for controls that derive from System.Web.UI.WebControls.BaseValidator.
BaseValidatorDesigner
Example Syntax:
UpdateDesignTimeHtml
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
ButtonDesigner class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides design-time support for the System.Web.UI.WebControls.Button Web server control.
ButtonDesigner
Example Syntax:
UpdateDesignTimeHtml
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
CalendarAutoFormatDialog class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides an AutoFormat page for a System.Web.UI.WebControls.Calendar Web server control.
CalendarAutoFormatDialog
Example Syntax:
UpdateDesignTimeHtml
Create a new AutoFormatPage instance Create a new AutoFormatPage instance
AcceptButton
AccessibilityObject
AccessibleDefaultActionDescription
AccessibleDescription
AccessibleName
AccessibleRole
ActiveControl
ActiveMdiChild
AllowDrop
AllowTransparency
Anchor
AutoScale
AutoScaleBaseSize
AutoScroll
AutoScrollMargin
AutoScrollMinSize
AutoScrollPosition
BackColor
BackgroundImage
BindingContext
Bottom
Bounds
CancelButton
CanFocus
CanSelect
Capture
CausesValidation
ClientRectangle
ClientSize
CompanyName
Container
ContainsFocus
ContextMenu
ControlBox
Controls
Created
CreateParams
Cursor
DataBindings
DefaultImeMode
DefaultSize
DesignMode
DesktopBounds
DesktopLocation
DialogResult
DisplayRectangle
Disposing
Dock
DockPadding
Enabled
Events
Focused
Font
FontHeight
ForeColor
FormBorderStyle
Handle
HasChildren
Height
HelpButton
HScroll
Icon
ImeMode
InvokeRequired
IsAccessible
IsDisposed
IsHandleCreated
IsMdiChild
IsMdiContainer
IsRestrictedWindow
KeyPreview
Left
Location
MaximizeBox
MaximizedBounds
MaximumSize
MdiChildren
MdiParent
Menu
MergedMenu
MinimizeBox
MinimumSize
Modal
Name
Opacity
OwnedForms
Owner
Parent
ParentForm
ProductName
ProductVersion
RecreatingHandle
Region
RenderRightToLeft
ResizeRedraw
Right
RightToLeft
ShowFocusCues
ShowInTaskbar
ShowKeyboardCues
Site
Size
SizeGripStyle
StartPosition
TabIndex
TabStop
Tag
Text
Top
TopLevel
TopLevelControl
TopMost
TransparencyKey
Visible
VScroll
Width
WindowState
WindowTarget
DoDelayLoadActions
Executes any initialization that was delayed until the first idle time Executes any initialization that was delayed until the first idle time
OnActivated
Handles the activated event of the System.Web.UI.WebControls.Calendar AutoFormat dialog.
This method provides an opportunity to perform operations after a Calendar AutoFormat dialog has been activated. The source of the event. An System.EventArgs that provides information about the event.
OnOKClicked
Handle changes in the pre-defined schema choices Handle changes in the pre-defined schema choices
OnSelChangedScheme
Handle changes in the pre-defined schema choices Handle changes in the pre-defined schema choices
SaveComponent
Save any changes into the component Save any changes into the component CalendarDesigner class (System.Web.UI.Design.WebControls)
WndProc
Description
Provides design-time support for the System.Web.UI.WebControls.Calendar Web server control.
CalendarDesigner
Example Syntax:
WndProc
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
WndProc
Description
Gets the set of verbs available to this designer.
Initialize
Initializes the designer with the component for design.
The designer host calls System.Web.UI.Design.WebControls.CalendarDesigner.Initialize(System.ComponentModel.IComponent) to establish the component for design. The control element for design.
OnAutoFormat
Delegate to handle the the AutoFormat verb that displays a new System.Web.UI.Design.WebControls.CalendarAutoFormatDialog. The source of the event. The System.EventArgs object that provides data about the event.
CheckBoxDesigner class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides design-time support for the System.Web.UI.WebControls.CheckBox Web server control.
CheckBoxDesigner
Example Syntax:
UpdateDesignTimeHtml
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
DataGridColumnCollectionEditor class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides a collection editing user interface for a column collection of a System.Web.UI.WebControls.DataGrid Web server control.
DataGridColumnCollectionEditor
Example Syntax:
UpdateDesignTimeHtml
EditValue
Edits the specified value using the specified context descriptor and service provider.
Return Value: The new value. An System.ComponentModel.ITypeDescriptorContext that indicates the context of the object to edit the value of. An System.IServiceProvider. The object to edit.
GetEditStyle
Gets the edit style used by the System.Web.UI.Design.WebControls.DataGridColumnCollectionEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System. IServiceProvider,System.Object) method.
Return Value: A System.Drawing.Design.UItypeEditorEditStyle that represents the editor style that this editor uses. An System.ComponentModel.ITypeDescriptorContext that indicates the context of the object to edit the value of.
DataGridComponentEditor class (System.Web.UI.Design.WebControls)
ToString
Description
Provides a component editor for a Web Forms System.Web.UI.WebControls.DataGrid Web server control.
DataGridComponentEditor
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.WebControls.DataGridComponentEditor class.
DataGridComponentEditor
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.WebControls.DataGridComponentEditor class. The index of the initial page.
GetComponentEditorPages
Gets the set of all pages in the System.Web.UI.WebControls.DataGrid control.
Return Value: An array consisting of the set of component editor pages.
This method can be overridden to change the set of pages to show.
DataGridDesigner class (System.Web.UI.Design.WebControls)
ToString
Description
Provides design-time support for the System.Web.UI.WebControls.DataGrid Web server control.
DataGridDesigner
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.WebControls.DataGridDesigner class.
ActiveTemplateEditingFrame
AllowResize
AssociatedComponents
Behavior
CanEnterTemplateMode
Component
DataBindings
DataKeyField
DataMember
DataSource
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
HidePropertiesInTemplateMode
ID
InheritanceAttribute
Inherited
InTemplateMode
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
CreateTemplateEditingFrame
Creates a template editing frame using the specified verb.
Return Value: The new template editing frame. The verb to create the template editing frame for.
Dispose
Releases the unmanaged resources used by the System.Web.UI.Design.WebControls.DataGridDesigner and optionally releases the managed resources.
This method is called by the public Dispose( ) method and the System.Object.Finalize method. true to release both managed and unmanaged resources; false to release only unmanaged resources.
GetCachedTemplateEditingVerbs
Gets the cached template editing verbs.
Return Value: An array containing the cached template editing verbs.
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
GetEmptyDesignTimeHtml
Gets the HTML used to represent an empty template-based control at design time.
Return Value: The HTML used to represent an empty template-based control at design time.
GetErrorDesignTimeHtml
Gets the HTML displayed at design-time for the specified exception when an error has been encountered while rendering the control.
Return Value: The HTML displayed at design-time for the specified exception. The exception to display an error message for.
GetTemplateContainerDataltemProperty
Gets the template's container's data item property.
Return Value: The template's container's data item property. The name of the template.
GetTemplateContent
Gets the template's content.
Return Value: The template's content. The template frame to retrieve content for. The name of the template. A boolean variable that will be set to true if the template's content can be edited, or false if the content is read-only.
GetTemplatePropertyParentType
Gets the type of the parent of the template property.
Return Value: The type of the object that has the template property. The name of the template to return the type of the parent for.
Initialize
Initializes the designer with the System.Web.UI.WebControls.DataGrid control that this instance of the designer is associated with. The associated System.Web.UI.WebControls.DataGrid control.
OnColumnsChanged
Notification that is called when the columns changed event occurs.
OnTemplateEditingVerbsChanged
Provides an opportunity to do processing or other actions when a change has been made to the template editing verbs.
SetTemplateContent
Sets the content for the specified template and frame. The template frame to set the content for. The name of the template. The content to set.
DataListComponentEditor class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides a component editor for a Web Forms System.Web.UI.WebControls.DataList control.
DataListComponentEditor
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of System.Web.UI.Design.WebControls.DataListComponentEditor.
DataListComponentEditor
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of System.Web.UI.Design.WebControls.DataListComponentEditor. The index of the initial page to display.
GetComponentEditorPages
Gets the set of component editor pages owned by the designer.
Return Value: The pages owned by the designer.
DataListDesigner class (System.Web.UI.Design.WebControls)
ToString
Description
Provides design-time support for the System.Web.UI.WebControls.DataList Web server control.
DataListDesigner
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.WebControls.DataListDesigner class.
ActiveTemplateEditingFrame
AllowResize
ToString
Description
Indicates whether the data list can be resized.
AssociatedComponents
Behavior
CanEnterTemplateMode
Component
DataBindings
DataKeyField
DataMember
DataSource
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
HidePropertiesInTemplateMode
ID
InheritanceAttribute
Inherited
InTemplateMode
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
TemplatesExist
ToString
Description
Indicates whether templates associated to the designer currently exist.
Verbs
CreateTemplateEditingFrame
Creates a template editing frame using the specified verb.
Return Value: An System.Web.UI.Design.ITemplateEditingFrame. The verb that was invoked to create a template editing frame.
Dispose
Releases the unmanaged resources used by the System.Web.UI.Design.WebControls.DataListDesigner and optionally releases the managed resources.
This method is called by the public Dispose( ) method and the System.Object.Finalize method. true to release both managed and unmanaged resources; false to release only unmanaged resources.
GetCachedTemplateEditingVerbs
Gets the cached template editing verbs available to this designer.
Return Value: The cached template editing verbs available to this designer.
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
GetEmptyDesignTimeHtml
Gets the HTML used to represent an empty template-based control at design time.
Return Value: The HTML used to represent an empty template-based control at design time.
GetErrorDesignTimeHtml
Gets the HTML to display at design-time for the specified exception when an error has been encountered while rendering the control.
Return Value: The HTML displayed at design-time for the specified exception. The exception to display the error message for.
GetTemplateContainerDataltemProperty
Gets the template's container's data item property.
Return Value: The data item property of the container of the template. The name of the template.
GetTemplateContent
Gets the template's content.
Return Value: The template's content. The template frame to get content from. The name of the template. A boolean variable that will be set to true if the template's content can be edited, or false if the content is read-only.
Initialize
Initializes the designer with the System.Web.UI.WebControls.DataList control that this instance of the designer is associated with. The associated System.Web.UI.WebControls.DataList control.
OnTemplateEditingVerbsChanged
Provides an opportunity to do processing or other actions when a change has been made to the template editing verbs.
SetTemplateContent
Sets the template's content. The template frame to set content for. The name of the template. The content to set.
HyperLinkDesigner class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides design-time support for the System.Web.UI.WebControls.HyperLink Web server control.
HyperLinkDesigner
Example Syntax:
UpdateDesignTimeHtml
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
LabelDesigner class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides design-time support for the System.Web.UI.WebControls.Label Web server control.
LabelDesigner
Example Syntax:
UpdateDesignTimeHtml
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
LinkButtonDesigner class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides design-time support for the System.Web.UI.WebControls.LinkButton Web server control.
LinkButtonDesigner
Example Syntax:
UpdateDesignTimeHtml
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
ListControlDataBindingHandler class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides a data binding handler for a System.Web.UI.WebControls.ListControl.
ListControlDataBindingHandler
Example Syntax:
UpdateDesignTimeHtml
DataBindControl
Adds a data binding to the specified control. The designer host for the document that contains the control. The control to add this data binding to.
ListControlDesigner class (System.Web.UI.Design.WebControls)
ToString
Description
Provides design-time support for System.Web.UI.WebControls.ListControl Web server controls.
ListControlDesigner
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.WebControls.ListControlDesigner class.
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DataMember
ToString
Description
Gets or sets the data member for the control.
DataSource
ToString
Gets or sets the data source property of the control.
DataTextField
ToString
Gets or sets the data text field of the control.
DataValueField
ToString
[C#] public string DataValueField {get; set;}
Gets or sets the data value field of the control.
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
GetResolvedSelectedDataSource
Gets the data member that is currently selected within the data source currently bound to the control.
Return Value: The currently selected data member, or null 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.
GetSelectedDataSource
Gets the selected data source component from the component's container.
Return Value: The selected data source, or null if a data source is not found or if a data source with the same name does not exist.
Initialize
Initializes the component for design.
This method is called to initialize the designer with the component to design. The control that is being designed.
OnComponentChanged
Raises the ComponentChanged event.
Handles changes made to the component. This includes changes made in the Properties window. The source of the event. A System.ComponentModel.Design.ComponentChangedEventArgs that provides data about the event.
OnDataSourceChanged
Raises the DataSource event.
Handles changes made to the data source.
PreFilterProperties
Filters the properties exposed through a System.ComponentModel.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. The properties of the control.
ListItemsCollectionEditor class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides a user interface for editing the items collection of a list.
ListItemsCollectionEditor
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of the System.Web.UI.Design.WebControls.ListItemsCollectionEditor class. The type of the collection to edit.
CollectionItemType
CollectionType
Context
HelpTopic
NewItemTypes
CanSelectMultipleInstances
Indicates whether multiple items in the list can be selected at the same time.
Return Value: true if multiple items can be selected at the same time; otherwise, false.
PanelDesigner class (System.Web.UI.Design.WebControls)
ToString
Description
Provides design-time support for the System.Web.UI.WebControls.Panel Web server control.
PanelDesigner
Example Syntax:
ToString
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
MapPropertyToStyle
Maps a specified property and value to a specified HTML style. The property name. The property value.
OnBehaviorAttached
Provides notification when a behavior is attached to the designer.
RegexEditorDialog class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides a dialog for editing regular expressions used by the System.Web.UI.WebControls.RegularExpressionValidator.
RegexEditorDialog
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of the System.Web.UI.Design.WebControls.RegexEditorDialog class. The site for this dialog.
AcceptButton
AccessibilityObject
AccessibleDefaultActionDescription
AccessibleDescription
AccessibleName
AccessibleRole
ActiveControl
ActiveMdiChild
AllowDrop
AllowTransparency
Anchor
AutoScale
AutoScaleBaseSize
AutoScroll
AutoScrollMargin
AutoScrollMinSize
AutoScrollPosition
BackColor
BackgroundImage
BindingContext
Bottom
Bounds
CancelButton
CanFocus
CanSelect
Capture
CausesValidation
ClientRectangle
ClientSize
CompanyName
Container
ContainsFocus
ContextMenu
ControlBox
Controls
Created
CreateParams
Cursor
DataBindings
DefaultImeMode
DefaultSize
DesignMode
DesktopBounds
DesktopLocation
DialogResult
DisplayRectangle
Disposing
Dock
DockPadding
Enabled
Events
Focused
Font
FontHeight
ForeColor
FormBorderStyle
Handle
HasChildren
Height
HelpButton
HScroll
Icon
ImeMode
InvokeRequired
IsAccessible
IsDisposed
IsHandleCreated
IsMdiChild
IsMdiContainer
IsRestrictedWindow
KeyPreview
Left
Location
MaximizeBox
MaximizedBounds
MaximumSize
MdiChildren
MdiParent
Menu
MergedMenu
MinimizeBox
MinimumSize
Modal
Name
Opacity
OwnedForms
Owner
Parent
ParentForm
ProductName
ProductVersion
RecreatingHandle
Region
RegularExpression
UpdateDesignTimeHtml
Description
Gets or sets the name of the regular expression to edit.
RenderRightToLeft
ResizeRedraw
Right
RightToLeft
ShowFocusCues
ShowInTaskbar
ShowKeyboardCues
Site
Size
SizeGripStyle
StartPosition
TabIndex
TabStop
Tag
Text
Top
TopLevel
TopLevelControl
TopMost
TransparencyKey
Visible
VScroll
Width
WindowState
WindowTarget
cmdHelp_Click
Represents the method that will handle the Help event of the dialog. The source of the event. An EventArgs that provides data for the event.
cmdOK_Click
Represents the method that will handle the OK event of the dialog. The source of the event. An EventArgs that provides data for the event.
cmdTestValidate_Click
Represents the method that will handle the XXX event of a XXX. The source of the event. An EventArgs that provides data for the event.
Dispose
Releases the unmanaged resources used by the System.Web.UI.Design.WebControls.RegexEditorDialog and optionally releases the managed resources.
This method is called by the public Dispose( ) method and the System.Object.Finalize method.
1stStandardExpressions_SelectedIndexChanged
Represents the method that will handle the XXX event of a XXX. The source of the event. An EventArgs that provides data for the event.
RegexTypeEditor_Activated
Represents the method that will handle the XXX event of a XXX. The source of the event. An EventArgs that provides data for the event.
txtExpression_TextChanged
Represents the method that will handle the XXX event of a XXX. The source of the event. An EventArgs that provides data for the event.
RegexTypeEditor class (System.Web.UI.Design.WebControls)
WndProc
Description
Provides a user interface for editing regular expressions.
RegexTypeEditor
Example Syntax:
WndProc
EditValue
Edits the value of the specified object using the specified service provider and context.
Return Value: The new value of the object. If the value of the object hasn't changed, this should return the same object it was passed. An System.ComponentModel.ITypeDescriptorContext that can provide additional context information. A service provider. The object to edit the value of.
GetEditStyle
Gets the editor style used by the System.Web.UI.Design.WebControls.RegexTypeEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object) method.
Return Value: A System.Drawing.Design.UItypeEditorEditStyle that indicates the editor style. An System.ComponentModel.ITypeDescriptorContext that may be used to gain additional context information.
RepeaterDesigner class (System.Web.UI.Design.WebControls)
ToString
Description
Provides a designer for the System.Web.UI.WebControls.Repeater control.
RepeaterDesigner
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.WebControls.RepeaterDesigner class.
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DataMember
ToString
Description
DataSource
ToString
Designer implementation of DataSource property that operates on the DataSource property in the control's binding collection.
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
TemplatesExist
ToString
Description
Verbs
Dispose
Performs the cleanup of the designer class.
GetDesignTimeDataSource
IEnumerable;
Description
Returns a sample data matching the schema of the selected datasource.
Return Value: A live datasource for use at design-time. The minimum rows of sample data the datasource should contain.
GetDesignTimeDataSource
Returns a sample data matching the schema of the selected datasource.
Return Value: A live datasource for use at design-time. The selected datasource to be used as a reference for the shape of the data. The minimum rows of sample data the datasource should contain.
GetDesignTimeHtml
Retrieves the HTML to be used for the design-time representation of the control.
Return Value: Design Time HTML.
GetEmptyDesignTimeHtml
GetErrorDesignTimeHtml
GetResolvedSelectedDataSource
GetSelectedDataSource
Retrieves the selected datasource component from the component's container.
Return Value: The selected datasource; null if a datasource is not found, or a datasource with the same name does not exist.
Initialize
Initializes the designer with the Repeater control that this instance of the designer is associated with. The associated Repeater control.
OnComponentChanged
Handles changes made to the component. This includes changes made in the Properties window.
OnDataSourceChanged
Handles changes made to the data source Handles changes made to the data source
PreFilterProperties
Filter the properties to replace the runtime DataSource property descriptor with the designer's.
TableCellsCollectionEditor class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides a user interface for editing cells in a table.
TableCellsCollectionEditor
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of the System.Web.UI.Design.WebControls.TableCellsCollectionEditor class. The type of the collection to edit.
CollectionItemType
CollectionType
Context
HelpTopic
NewItemTypes
CanSelectMultipleInstances
Indicates whether multiple table cells can be selected at the same time. Return Value: true if multiple cells can be selected at the same time; otherwise, false.
CreateInstance
Creates an instance of the editor for use with the specified type.
Return Value: An object of the specified type. The type to create an instance of.
TableDesigner class (System.Web.UI.Design.WebControls)
ToString
Description
Provides design-time support for the System.Web.UI.WebControls.Table Web server control.
TableDesigner
Example Syntax:
ToString
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time. Return Value: The HTML that is used to represent the control at design time.
TableRowsCollectionEditor class (System.Web.UI.Design.WebControls)
UpdateDesignTimeHtml
Description
Provides a user interface for editing rows of a table.
TableRowsCollectionEditor
Example Syntax:
UpdateDesignTimeHtml
Initializes a new instance of the System.Web.UI.Design.WebControls.TableRowsCollectionEditor class. The type of the collection to edit.
CollectionItemType
CollectionType
Context
HelpTopic
NewItemTypes
CanSelectMultipleInstances
Indicates whether multiple instances may be selected.
Return Value: true if multiple items can be selected at once; otherwise, false. This implementation always returns false.
CreateInstance
Creates an instance of the specified type.
Return Value: An object of the specified type. The type to create an instance of.
XmlDesigner class (System.Web.UI.Design.WebControls)
ToString
Description
Provides a designer for the System.Web.UI.WebControls.Xml Web server control.
XmlDesigner
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.Design.WebControls.XmlDesigner class.
AllowResize
AssociatedComponents
Behavior
Component
DataBindings
DesignTimeElement
DesignTimeElementView
DesignTimeHtmlRequiresLoadComplete
ID
InheritanceAttribute
Inherited
IsDirty
ReadOnly
ShadowProperties
ShouldCodeSerialize
Verbs
Dispose
Performs the cleanup of the designer class.
GetDesignTimeHtml
Gets the HTML that is used to represent the control at design time.
Return Value: The HTML that is used to represent the control at design time.
GetEmptyDesignTimeHtml
Gets the HTML that is used to fill an empty control.
Return Value: The HTML used to fill an empty control.
Initialize
The System.Web.UI.HtmlControls namespace is a collection of classes that allow you to create HTML server controls on a Web page. HTML server controls run on the server and map directly to standard HTML tags supported by all browsers. This allows you to programmatically control the HTML elements on the Web page.
HtmlAnchor class (System.Web.UI.HtmlControls)
Description
Defines the methods, properties, and events for the System.Web.UI.HtmlControls.Html;Anchor control. This class allows programmatic access to the HTML tag on the server.
There are two ways to use the System.Web.UI.HtmlControls.HtmlAnchor class. The first is for navigation: using the System.Web.UI.HtmlControls.HtmlAnchor.HRef property to define the location of the page to link to. The second is for postback events: using the System.Web.UI.HtmlControls.HtmlAnchor.ServerClick event to programmatically handle the user's click on a link.
Constructors:
HtmlAnchor
Example Syntax:
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlAnchor class.
Properties:
Attributes
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
HRef
Description
Gets or sets the URL target of the link specified in the System.Web.UI.HtmlControls.HtmlAnchor server control.
Use this property to specify the URL to link to when the System.Web.UI.HtmlControls.HtmlAnchor is clicked.
ID
InnerHtml
InnerText
IsTrackingViewState
Name
Description
Gets or sets the bookmark name defined in the System.Web.UI.HtmlControls.HtmlAnchor server control.
Use this property to mark sections on a Web page with a name. This allows you to link to this section from anywhere on the same page. For example, you can provide a table of contents at the top of a page that will link directly to topics on the page.
NamingContainer
Page
Parent
Site
Style
TagName
Target
Description
Gets or sets the target window or frame to load Web page content into.
Use this property to specify the frame or window that displays the Web page linked to.
TemplateSourceDirectoly
Title
Description
Gets or sets the title that the browser displays for a Web page.
Use this property to specify a custom title when the browser identifies the page you link to. This property also may be used to provide a custom tool tip for the System.Web.UI.HtmlControls.HtmlAnchor control.
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Description
Occurs on the server when a user clicks the System.Web.UI.HtmlControls.HtmlAnchor control on the browser.
This event is raised when the System.Web.UI.HtmlControls.HtmlAnchor is clicked.
Methods:
OnServerClick
Raises the System.Web.UI.HtmlControls.HtmlAnchor.ServerClick event. This allows you to handle the event directly.
This server event causes a roundtrip to occur from the client to the server and back. An System.EventArgs that contains event data.
RenderAttributes
IpostBackEventHandler.RaisePostBackEvent
HtmlButton class (System.Web.UI.HtmlControls)
TrackViewState
Description
Defines the methods, properties, and events for the System.Web.UI.HtmlControls.HtmlButton control. This class allows programmatic access to the HTML tag on the server.
The element allows Web developers to create UI form buttons that can be composed of embedded HTML elements, including other server controls.
HtmlButton
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlButton class.
Attributes
CausesValidation
TrackViewState
Description
Gets or sets a value indicating whether validation is performed when the System.Web.UI.HtmlControls.HtmlButton control is clicked.
By default, page validation is performed when an System.Web.UI.HtmlControls.HtmlButton control is clicked. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control.
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
InnerHtml
InnerText
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TagName
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
Visible
TrackViewState
Description
Occurs when the user clicks an System.Web.UI.HtmlControls.HtmlButton control on the client Web page.
This event is raised when the System.Web.UI.HtmlControls.HtmlButton is clicked.
OnServerClick
Raises the System.Web.UI.HtmlControls.HtmlButton.ServerClick event. This allows you to handle the event directly.
This event causes a roundtrip to occur from the client to the server and back. It is deliberately different from the client-side OnClick event. In the event that a conflict exists between code run with a System.Web.UI.HtmlControls.HtmlButton.ServerClick event and code run by a client-side OnClick event, the server-side event instructions will override the client-side code. An System.EventArgs that contains the event data.
RenderAttributes
IPostBackEventHandler.RaisePostBackEvent
HtmlContainerControl class (System.Web.UI.HtmlControls)
TrackViewState
Description
Defines the methods, properties, and events available to all HTML server controls that must have a closing tag.
The most common controls with a closing tag are the
Top of Form
,,
,, and elements.
HtmlContainerControl
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlContainerControl class using default values.
Use this constructor to create and initialize a new instance of the System.Web.UI.HtmlControls.HtmlContainerControl class using default values.
HtmlContainerControl
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlContainerControl class using the specified tag name.
Use this constructor to create and initialize a new instance of the System.Web.UI.HtmlControls.HtmlContainerControl class using the specified tag. A string that specifies the tag name of the control.
Attributes
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
InnerHtml
TrackViewState
Description
Gets or sets the content found between the opening and closing tags of the specified HTML server control.
Use the System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml property to programmatically modify the contents within the opening and closing tags of an HTML server control.
InnerText
TrackViewState
Gets or sets the text between the opening and closing tags of the specified HTML server control.
Use the System.Web.UI.HtmlControls.HtmlContainerControl.InnerText property to programmatically modify the contents between the opening and closing tags of an HTML server control.
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TagName
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
Visible
CreateControlCollection
LoadViewState
Render
RenderAttributes
RenderEndTag
HtmlControl class (System.Web.UI.HtmlControls)
TrackViewState
Description
Defines the methods, properties, and events common to all HTML server controls in the Web Forms page framework.
The System.Web.UI.HtmlControls.HtmlControl class provides common properties inherited by all HTML server control classes. It is not instantiated directly.
HtmlControl
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlControl class using default values.
This constructor is used to create and initialize a new instance of the System.Web.UI.HtmlControls.HtmlControl class using default values.
HtmlControl
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlControl class using the specified tag.
This constructor is used to create and initialize a new instance of the System.Web.UI.HtmlControls.HtmlControl class using the specified tag. A string that specifies the tag name of the control.
Attributes
TrackViewState
Gets a collection of all attribute name and value pairs expressed on a server control tag within the .aspx file.
Use this property to programmatically access the attributes of the HTML server control. All Html server controls store their attributes in the System.Web.UI.Control.ViewState.
ChildControlsCreated
ClientID
Context
Controls
Disabled
TrackViewState
Description
Gets or sets a value indicating whether the HTML server control is disabled.
On the browser, a disabled element or control is read-only, with the following added restrictions: its value is not submitted with the form, the element or control cannot receive focus, and the element or control is skipped when navigating the document by tabbing.
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TrackViewState
Description
Gets a collection of all cascading style sheet (CSS) properties applied to a specified HTML server control in the .aspx file.
Use this property to programmatically access the style properties of the HTML server control.
TagName
TrackViewState
Gets the element name of a tag that contains a runat=server attribute and value pair.
Use this property to programmatically determine the element name of the HTML server control.
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
TrackViewState
Description
Visible
CreateControlCollection
Render
RenderAttributes
RenderBeginTag
IAttributeAccessor.GetAttribute
IAttributeAccessor. SetAttribute
HtmlForm class (System.Web.UI.HtmlControls)
TrackViewState
Description
Provides programmatic access to the HTML
Top of Form
element on the server.
The System.Web.UI.HtmlControls.HtmlForm control is used as a container for server controls on a Web page. All server controls that post back to the server must be placed between the opening and closing tags of an System.Web.UI.HtmlControls.HtmlForm control.
HtmlForm
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlForm class.
Use this constructor to create and initialize a new instance of the System.Web.UI.HtmlControls.HtmlForm class.
Attributes
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Enctype
TrackViewState
Description
Gets or sets the encoding type browsers use when posting the form's data to the server.
Use this property to specify the encoding type browsers use to post data back to the server.
Events
HasChildViewState
ID
InnerHtml
InnerText
IsTrackingViewState
Method
TrackViewState
Description
Gets or sets a value that indicates how a browser posts form data to the server for processing.
Use this property to specify how the browser sends form data to the server for processing. The two common methods supported by all browsers are GET and POST.
Name
TrackViewState
Gets the identifier name for the System.Web.UI.HtmlControls.HtmlForm control.
Use this property to identify a specific System.Web.UI.HtmlControls.HtmlForm control.
NamingContainer
Page
Parent
Site
Style
TagName
Target
TrackViewState
Description
Gets or sets the frame or window to render the results of information posted to the server.
Use this property to display the results of information posted to the server in another browser window or frame.
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
Visible
OnInit
Call RegisterViewStateHandler( ).
Render
RenderAttributes
RenderChildren
HtmlGenericControl class (System.Web.UI.HtmlControls)
TrackViewState
Description
Defines the methods, properties, and events for all HTML server control tags not represented by a specific .NET Framework class.
Use this class to represent an HTML server control tag not directly represented by a .NET Framework class, such as,
,
,and.
HtmlGenericControl
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlGenericControl class with default values.
The following table shows initial property values for an instance of System.Web.UI.HtmlControls.HtmlGenericControl.
HtmlGenericControl
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlGenericControl class with the specified tag.
The following table shows initial property values for an instance of System.Web.UI.HtmlControls.HtmlGenericControl. The name of the element for which the instance of this class is created.
Attributes
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
InnerHtml
InnerText
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TagName
TrackViewState
Description
Gets or sets the tag name of an element that contains a runat=“server” attribute.
Use this property to dynamically change the tag name of a generic control on the Web page.
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
Visible
HtmlImage class (System.Web.UI.HtmlControls)
TrackViewState
Description
Provides programmatic access for the HTML
element on the server.
Use this control to display an image on a Web page. The System.Web.UI.HtmlControls.HtmlImage control can be programmatically manipulated to change the image displayed, the image size, and the alignment of the image relative to other page elements.
HtmlImage
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlImage class.
Use this constructor to create and initialize a new instance of the System.Web.UI.HtmlControls.HtmlImage class.
Align
TrackViewState
Gets or sets the alignment of the image relative to other Web page elements.
Use this property to specify the alignment of the image with respect to other elements on the Web page.
Alt
TrackViewState
Gets or sets the alternative caption the browser displays if an image is unavailable or currently downloading and not yet finished.
Use this property to specify the caption displayed when the image specified by the System.Web.UI.HtmlControls.HtmlImage.Src property is unavailable. On newer browsers, this caption also appears as a ToolTip.
Attributes
Border
TrackViewState
Description
Gets or sets the width of a frame for an image.
Use this property to create a frame with the specified width (in pixels) for an image.
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
Height
TrackViewState
Description
Gets or sets the height of the image.
The System.Web.UI.HtmlControls.HtmlImage.Height and System.Web.UI.HtmlControls.HtmlImage.Width properties can be used two ways. You can use the System.Web.UI.HtmlControls.HtmlImage.Height and System.Web.UI.HtmlControls.HtmlImage.Width properties to send image size specifications to the browser. This displays the Web page faster because the browser does not need to recalculate the positions of elements on the page when the image loads.
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Src
TrackViewState
Description
Gets or sets the source of the image file to display.
Use this property to specify the path to the image file to display. If the image file is in the same directory as the Web page source file that uses it, you can just specify the file name. Otherwise, you must also include the path to the file. The path can be absolute or relative to the directory that contains the Web page source file.
Style
TagName
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
TrackViewState
Description
Gets or sets the width of the image.
The System.Web.UI.HtmlControls.HtmlImage.Height and System.Web.UI.HtmlControls.HtmlImage.Width properties can be used two ways. You can use the System.Web.UI.HtmlControls.HtmlImage.Height and System.Web.UI.HtmlControls.HtmlImage.Width properties to send the image size specifications to the browser. This displays the Web page faster because the browser does not need to recalculate the positions of elements on the page when the image loads.
RenderAttributes
HtmlInputButton class (System.Web.UI.HtmlControls)
TrackViewState
Description
Allows programmatic access to the HTML,
elements on the server.
Use this class to create button controls on a Web page.
HtmlInputButton
Example Syntax:
TrackViewState
Initializes a new instance of an System.Web.UI.HtmlControls.HtmlInputButton class using default values.
The following table shows the initial property value for an instance of System.Web.UI.HtmlControls.HtmlInputButton.
HtmlInputButton
Example Syntax:
TrackViewState
Initializes a new instance of an System.Web.UI.HtmlControls.HtmlInputButton class using the specified button type.
The following table shows the initial property value for an instance of System.Web.UI.HtmlControls.HtmlInputButton. The input button type.
Attributes
CausesValidation
TrackViewState
Description
Gets or sets a value indicating whether validation is performed when the System.Web.UI.HtmlControls.HtmlInputButton control is clicked.
By default, page validation is performed when an System.Web.UI.HtmlControls.HtmlInputButton control is clicked. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control.
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
Name
NamingContainer
Page
Parent
Site
Style
TagName
TemplateSourceDirectory
Type
UniqueID
Value
ViewState
ViewStateIgnoresCase
Visible
TrackViewState
Description
Occurs when an System.Web.UI.HtmlControls.HtmlInputButton control is clicked on the Web page.
This event is raised when an System.Web.UI.HtmlControls.HtmlInputButton control is clicked.
OnServerClick
Raises the System.Web.UI.HtmlControls.HtmlInputButton.ServerClick event. This allows you to handle the event directly.
The System.Web.UI.HtmlControls.HtmlInputButton.ServerClick event is raised when an System.Web.UI.HtmlControls.HtmlInputButton control is clicked. A System.EventArgs that contains the event data.
RenderAttributes
IPostBackEventHandler.RaisePostBackEvent
HtmlInputCheckBox class (System.Web.UI.HtmlControls)
TrackViewState
Description
Allows programmatic access to the HTML element on the server.
Use the System.Web.UI.HtmlControls.HtmlInputCheckBox control to allow the user to select a true or false state.
HtmlInputCheckBox
Example Syntax:
TrackViewState
Description
Initializes a new instance of an System.Web.UI.HtmlControls.HtmlInputCheckBox class.
Use this constructor to create and initialize a new instance of the System.Web.UI.HtmlControls.HtmlInputCheckBox class.
Attributes
Checked
TrackViewState
Description
Gets or sets a value indicating whether the System.Web.UI.HtmlControls.HtmlInputCheckBox is checked.
Use this property to determine whether the System.Web.UI.HtmlControls.HtmlInputCheckBox control is checked. This property can also be used to programmatically set the state of the System.Web.UI.HtmlControls.HtmlInputCheckBox control.
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
Name
NamingContainer
Page
Parent
Site
Style
TagName
TemplateSourceDirectory
Type
UniqueID
Value
ViewState
ViewStateIgnoresCase
Visible
TrackViewState
Description
Occurs when the Web page is submitted to the server and the System.Web.UI.HtmlControls.HtmlInputCheckBox control changes state from the previous post.
This event is raised when the Web page is submitted to the server and the state of the System.Web.UI.HtmlControls.HtmlInputCheckBox control changes state from the previous post.
OnPreRender
OnServerChange
Raises the System.Web.UI.HtmlControls.HtmlInputCheckBox.ServerChange event. This method allows you to handle the event directly.
This event is raised when the Web page is submitted to the server and the state of the System.Web.UI.HtmlControls.HtmlInputCheckBox control changes state from the previous post. This method allows you to override the base implementation and provide a custom handler for the event. A System.EventArgs that contains event information.
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
HtmlInputControl class (System.Web.UI.HtmlControls)
TrackViewState
Description
Serves as the abstract base class that defines the methods, properties, and events common to all HTML input controls, such as the,
and elements.
The System.Web.UI.HtmlControls.HtmlInputControl class cannot be instantiated directly. Instead, this class is inherited by other classes, such as the System.Web.UI.HtmlControls.HtmlInputText, System.Web.UI.HtmlControls.HtmlInputButton, System.Web.UI.HtmlControls.HtmlInputRadioButton, System.Web.UI.HtmlControls.HtmlInputCheckBox, System.Web.UI.HtmlControls.HtmlInputImage, System.Web.UI.HtmlControls.HtmlInputHidden, and System.Web.UI.HtmlControls.HtmlInputFile classes, to provide common basic functionality.
HtmlInputControl
Example Syntax:
TrackViewState
Description
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlInputControl class.
The following table shows initial property values for an instance of System.Web.UI.HtmlControls.HtmlInputControl. The type of input control.
Attributes
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
Name
TrackViewState
Description
Gets or sets the unique identifier name for the System.Web.UI.HtmlControls.HtmlInputControl.
Use the System.Web.UI.HtmlControls.HtmlInputControl.Name property to determine the unique identifier name for an System.Web.UI.HtmlControls.HtmlInputControl. In this implementation, the get accessor returns the value of the System.Web.UI.Control.UniqueID property. However, the set accessor does not assign a value to this property.
NamingContainer
Page
Parent
Site
Style
TagName
TemplateSourceDirectory
Type
TrackViewState
Description
Gets the type of an System.Web.UI.HtmlControls.HtmlInputControl.
Use this property get the type of an System.Web.UI.HtmlControls.HtmlInputControl.
UniqueID
Value
TrackViewState
Description
Gets or sets the contents of an System.Web.UI.HtmlControls.HtmlInputControl.
Use this property to determine the contents of an System.Web.UI.HtmlControls.HtmlInputControl. This property can also be used to programmatically set the contents of an System.Web.UI.HtmlControls.HtmlInputControl.
ViewState
ViewStateIgnoresCase
Visible
RenderAttributes
HtmlInputFile class (System.Web.UI.HtmlControls)
TrackViewState
Description
Allows programmatic access to the HTML element on the server.
Use the System.Web.UI.HtmlControls.HtmlInputFile server control to handle uploading binary or text files from a browser client to the server. File upload works with Microsoft Internet Explorer version 3.02 or later.
HtmlInputFile
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlInputFile class.
Use this constructor to create and initialize a new instance of the System.Web.UI.HtmlControls.HtmlInputFile class.
Accept
TrackViewState
Gets or sets a comma-separated list of MIME encodings used to constrain the file types the user can select.
Use this property to specify the file type that can be uploaded to the server. For example, to restrict the selection to images, set this property to “image/*”.
Attributes
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
MaxLength
TrackViewState
Description
Gets or sets the maximum length of the file path for the file to upload from the client machine.
Use this property to specify a limit for the number of characters that can be entered for the path to the file to upload.
Name
NamingContainer
Page
Parent
PostedFile
TrackViewState
Description
Gets access to the uploaded file specified by a client.
Browser security restrictions prevent this value from being maintained across multiple requests.
Site
Size
TrackViewState
Description
Gets or sets the width of the text box in which the file path is entered.
Use this property to specify the width of the text box in which to enter the file path.
Style
TagName
TemplateSourceDirectory
Type
UniqueID
Value
ViewState
ViewStateIgnoresCase
Visible
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
HtmlInputHidden class (System.Web.UI.HtmlControls)
TrackViewState
Description
Allows programmatic access to the HTML element on the server.
You can use the System.Web.UI.HtmlControls.HtmlInputHidden control to embed non-visible information within a
Top of Form
element. This information is sent when the Web page is posted back to the server.
HtmlInputHidden
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlInputHidden class.
Attributes
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
Name
NamingContainer
Page
Parent
Site
Style
TagName
TemplateSourceDirectory
Type
UniqueID
Value
ViewState
ViewStateIgnoresCase
Visible
TrackViewState
Description
Occurs when the System.Web.UI.HtmlControls.HtmlInputControl.Value property is changed on the server.
The System.Web.UI.HtmlControls.HtmlInputHidden.ServerChange event is raised when the System.Web.UI.HtmlControls.HtmlInputControl.Value property is changed on the server.
OnPreRender
OnServerChange
Raises the System.Web.UI.HtmlControls.HtmlInputHidden.ServerChange event.
The System.Web.UI.HtmlControls.HtmlInputHidden.ServerChange event is raised when the System.Web.UI.HtmlControls.HtmlInputControl.Value property is changed on the server. A System.EventArgs that contains event data.
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
HtmlInputImage class (System.Web.UI.HtmlControls)
TrackViewState
Description
Allows programmatic access to the HTML
element on the server.
Use the System.Web.UI.HtmlControls.HtmlInputlmage control to create a button that displays an image. You can programmatically control the action associated with the System.Web.UI.HtmlControls.HtmlInputlmage control by providing an event handler for the System.Web.UI.HtmlControls.HtmlInputlmage.ServerClick event.
HtmlInputImage
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlInputlmage class.
Align
TrackViewState
Gets or sets the alignment of the System.Web.UI.HtmlControls.HtmlInputlmage control in relation to other elements on the Web page.
Use the System.Web.UI.HtmlControls.HtmlInputImage.Align property to specify the alignment of the System.Web.UI.HtmlControls.HtmlInputlmage control in relation to the other elements on the Web page. The following table lists the possible values for this property.
Alt
TrackViewState
Gets or sets the alternative text that the browser displays if the image is unavailable or has not been downloaded.
Use the System.Web.UI.HtmlControls.HtmlInputImage.Alt property to specify the text to display when the specified image is not available or has not been downloaded. You can also use this property to programmatically determine the specified alternative text.
Attributes
Border
TrackViewState
Description
Gets or sets the border width for the System.Web.UI.HtmlControls.HtmlInputlmage control.
Use the System.Web.UI.HtmlControls.HtmlInputImage.Border property to specify the border width for the System.Web.UI.HtmlControls.HtmlInputlmage control.
CausesValidation
TrackViewState
Gets or sets a value indicating whether validation is performed when the System.Web.UI.HtmlControls.HtmlInputlmage control is clicked.
By default, page validation is performed when an System.Web.UI.HtmlControls.HtmlInputlmage control is clicked. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control.
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
Name
NamingContainer
Page
Parent
Site
Src
TrackViewState
Description
Gets or sets the location of the image file.
Use the System.Web.UI.HtmlControls.HtmlInputImage.Src property to specify the location of the image to display in the System.Web.UI.HtmlControls.HtmlInputlmage control. If the image is not available, the text specified in the System.Web.UI.HtmlControls.HtmlInputImage.Alt property is displayed.
Style
TagName
TemplateSourceDirectory
Type
UniqueID
Value
ViewState
ViewStateIgnoresCase
Visible
TrackViewState
Description
Occurs on the server when the user clicks an System.Web.UI.HtmlControls.HtmlInputlmage control.
The System.Web.UI.HtmlControls.HtmlInputlmage.ServerClick event is raised when the user clicks an System.Web.UI.HtmlControls.HtmlInputlmage control.
OnPreRender
OnServerClick
Raises the System.Web.UI.HtmlControls.HtmlInputlmage.ServerClick event.
The System.Web.UI.HtmlControls.HtmlInputlmage.ServerClick event is raised when the user clicks an System.Web.UI.HtmlControls.HtmlInputlmage control. A System.Web.UI.ImageClickEventArgs that contains event data.
RenderAttributes
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
IPostBackEventHandler.RaisePostBackEvent
HtmlInputRadioButton class (System.Web.UI.HtmlControls)
TrackViewState
Description
Allows programmatic access to the HTML element on the server.
Use the System.Web.UI.HtmlControls.HtmlInputRadioButton control to create a radio button on a Web page. The System.Web.UI.HtmlControls.HtmlInputRadioButton control does not provide built-in functionality to display a caption for the radio button. To create a caption, use literal text in the Web page at the desired location. This allows you to control where the caption is displayed relative to the radio button. For example, if you want to display the caption on the right side of the radio button, declare an System.Web.UI.HtmlControls.HtmlInputRadioButton control followed by the caption text.
HtmlInputRadioButton
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlInputRadioButton class.
Use this constructor to create and initialize a new instance of the System.Web.UI.HtmlControls.HtmlInputRadioButton class.
Attributes
Checked
TrackViewState
Description
Gets or sets a value indicating whether the System.Web.UI.HtmlControls.HtmlInputRadioButton control is selected.
Use the System.Web.UI.HtmlControls.HtmlInputRadioButton.Checked property to determine whether the System.Web.UI.HtmlControls.HtmlInputRadioButton control is selected. You can also use this property to programmatically specify whether the control is selected. If you have a group of System.Web.UI.HtmlControls.HtmlInputRadioButton controls, you need to iterate through each control and test the System.Web.UI.HtmlControls.HtmlInputRadioButton.Checked property of each control individually.
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
Name
TrackViewState
Description
Gets or sets the name of the group that the current instance of the System.Web.UI.HtmlControls.HtmlInputRadioButton class is associated with.
Group multiple System.Web.UI.HtmlControls.HtmlInputRadioButton controls together by specifying a common value for the System.Web.UI.HtmlControls.HtmlInputControl.Name property of each radio button you want to include in the group. When you group System.Web.UI.HtmlControls.HtmlInputRadioButton controls together, only one radio button in the group can be selected at a time. The System.Web.UI.HtmlControls.HtmlInputRadioButton.Checked property of the selected control is set to true, while the same property is set to false for all other check boxes in the group.
NamingContainer
Page
Parent
Site
Style
TagName
TemplateSourceDirectory
Type
UniqueID
Value
TrackViewState
Description
Gets or sets the quantity associated with the System.Web.UI.HtmlControls.HtmlInputRadioButton control.
Use the System.Web.UI.HtmlControls.HtmlInputRadioButton.Value property to associate a quantity with the System.Web.UI.HtmlControls.HtmlInputRadioButton control. The quantity is not restricted to a numeric value and can be any valid string. This is useful when you have multiple radio buttons and need perform a calculation based on the selection. For example, you can have radio buttons that represent different shipping methods. You can store the shipping cost in the System.Web.UI.HtmlControls.HtmlInputRadioButton.Value property. When the user selects the shipping method, you add the appropriate amount to the sales total.
ViewState
ViewStateIgnoresCase
Visible
TrackViewState
Description
Occurs when the value of the System.Web.UI.HtmlControls.HtmlInputRadioButton.Checked property of the System.Web.UI.HtmlControls.HtmlInputRadioButton control changes between posts to the server.
The System.Web.UI.HtmlControls.HtmlInputRadioButton.ServerChange event is raised when the System.Web.UI.HtmlControls.HtmlInputRadioButton.Checked property of the System.Web.UI.HtmlControls.HtmlInputRadioButton control changes value between posts to the server. This allows you to create a custom event handler that performs a specific set of instructions (such as data validation) when the event is raised.
OnPreRender
OnServerChange
Raises the System.Web.UI.HtmlControls.HtmlInputRadioButton.ServerChange event. This allows you to create a custom event handler when the event is raised.
The System.Web.UI.HtmlControls.HtmlInputRadioButton.ServerChange event is raised when the System.Web.UI.HtmlControls.HtmlInputRadioButton.Checked property of the System.Web.UI.HtmlControls.HtmlInputRadioButton control changes values between posts to the server. This allows you to create a custom event handler that performs a specific set of instructions (such as data validation)when the event is raised. A System.EventArgs that contains the event data.
RenderAttributes
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
HtmlInputText class (System.Web.UI.HtmlControls)
TrackViewState
Description
Allows programmatic access to the HTML
elements on the server.
Use the System.Web.UI.HtmlControls.HtmlInputText control to create a single line text box that allows the user to enter text or a password. Use the System.Web.UI.HtmlControls.HtmlInputText.MaxLength property to specify the maximum number of characters that can be entered in the text box. The System.Web.UI.HtmlControls.HtmlInputText.Size property allows you to specify the width of the text box.
HtmlInputText
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlInputText class using default values.
This constructor creates a text type text box control.
HtmlInputText
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.HtmlControls.HtmlInputText class using the specified input control type.
This constructor allows you to create a specific type of text box control, such as password. Only the password or text type is currently supported. This constructor is designed to allow you to create other text box types if they become available. The type of input control.
Attributes
ChildControlsCreated
ClientID
Context
Controls
Disabled
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
MaxLength
TrackViewState
Description
Gets or sets the maximum number of characters that can be entered in the text box.
Use the System.Web.UI.HtmlControls.HtmlInputText.MaxLength property to specify or determine the maximum number of characters that can be entered in the text box.
Name
NamingContainer
Page
Parent
Site
Size
TrackViewState
Description
Gets or sets the width of the text box.
Use the System.Web.UI.HtmlControls.HtmlInputText.Size property to specify or determine the width of the textbox, in characters.
Style
TagName
TemplateSourceDirectory
Type
UniqueID
Value
TrackViewState
Description
Gets or sets the contents of the text box.
Use the System.Web.UI.HtmlControls.HtmlInputText.Value property to programmatically determine the text entered by the user into the text box. You can also use this property to provide default text for the text box.
ViewState
ViewStateIgnoresCase
Visible
TrackViewState
Description
Occurs when the System.Web.UI.HtmlControls.HtmlInputText.Value property is changed on the server.
The System.Web.UI.HtmlControls.HtmlInputText.ServerChange event is raised when the System.Web.UI.HtmlControls.HtmlInputText.Value property is changed on the server.
OnPreRender
OnServerChange
Raises the System.Web.UI.HtmlControls.HtmlInputText.ServerChange event.
The System.Web.UI.HtmlControls.HtmlInputText.ServerChange event is raised when the System.Web.UI.HtmlControls.HtmlInputText.Value property is changed on the server. A System.EventArgs that contains event data.
RenderAttributes
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
HtmlSelect class (System.Web.UI.HtmlControls)
TrackViewState
Description
Allows programmatic access to the HTML
System.Web.UI.WebControls
Description
The System.Web.UI.WebControls namespace is a collection of classes that allow you to create Web server controls on a Web page. Web controls run on the server and include form controls such as buttons and text boxes, as well as special purpose controls such as a calendar. This allows you to programmatically control these elements on a Web page. Web controls are more abstract than HTML controls. Their object model does not necessarily reflect HTML syntax.
AdCreatedEventArgs class (System.Web.UI.WebControls)
Description
Provides data for the System.Web.UI.WebControls.AdRotator.AdCreated event of the System.Web.UI.WebControls.AdRotator control. This class cannot be inherited.
The System.Web.UI.WebControls.AdRotator.AdCreated event is raised when the System.Web.UI.WebControls.AdRotator displays an advertisement on the page.
Constructors:
AdCreatedEventArgs
Example Syntax:
Initializes a new instance of the System.Web.UI.WebControls.AdCreatedEventArgs class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.AdCreatedEventArgs class. A System.Collections.IDictionary containing the advertisement properties from the XML file.
Properties:
AdProperties
Gets a System.Collections.IDictionary object that contains all the advertisement properties for the currently displayed advertisement.
Use the System.Web.UI.WebControls.AdCreatedEventArgs.AdProperties property to get a System.Collections.IDictionary object that contains the advertisement properties for the currently displayed advertisement. The keys and values of the System.Collections.IDictionary object are of type System.String.
AlternateText
Gets or sets the alternate text displayed in the System.Web.UI.WebControls.AdRotator control when the advertisement image unavailable. Browsers that support the ToolTips feature display this text as a ToolTip for the advertisement.
Use the System.Web.UI.WebControls.AdCreatedEventArgs.AlternateText property to specify the text to display if the image specified in the System.Web.UI.WebControls.AdCreatedEventArgs.ImageUrl property is not available. In browsers that support the ToolTips feature, this text also displays as a ToolTip for the advertisement.
ImageUrl
Gets or sets the URL of an image to display in the System.Web.UI.WebControls.AdRotator control.
Use the System.Web.UI.WebControls.AdCreatedEventArgs.ImageUrl property to specify the URL of an image to display for an advertisement in the System.Web.UI.WebControls.AdRotator control. You can use a relative or an absolute URL. A relative URL relates the location of the image to the location of the Web page without specifying a complete path on the server. The path is relative to the location of the Web page. This makes it easier to move the entire site to another directory on the server without updating the path to the image in code. An absolute URL provides the complete path, so moving the site to another directory requires updating the code.
NavigateUrl
Gets or sets the Web page to display when the System.Web.UI.WebControls.AdRotator control is clicked.
Use the System.Web.UI.WebControls.AdCreatedEventArgs.NavigateUrl property to specify the Web page to display when the System.Web.UI.WebControls.AdRotator control is clicked.
Methods:
AdCreatedEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.AdRotator.AdCreated event of an System.Web.UI.WebControls.AdRotator control. The source of the event. An System.Web.UI.WebControls.AdCreatedEventArgs that contains the event data.
The System.Web.UI.WebControls.AdRotator.AdCreated event is raised when the System.Web.UI.WebControls.AdRotator displays an advertisement on the page.
AdRotator class (System.Web.UI.WebControls)
ToString
Description
Displays an advertisement banner on a Web page.
Use the System.Web.UI.WebControls.AdRotator control to display a randomly selected advertisement banner on the Web page. The displayed advertisement can change whenever the page refreshes.
AdRotator
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.AdRotator class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.AdRotator class.
AccessKey
AdvertisementFile
ToString
Description
Gets or sets the path to an XML file that contains advertisement information.
Use the System.Web.UI.WebControls.AdRotator.AdvertisementFile property to specify the location of an XML file that contains advertisement information. The XML file must reside within the same web site. For deployment and security purposes, you should place the file in the same web application. It is only possible to access an XML file that is located in a different application on the same site if the application has sufficient trust.
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ToString
Description
Font property. Has no effect on this control, so hide it.
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
KeywordFilter
ToString
Description
Gets or sets a category keyword to filter for specific types of advertisements in the XML advertisement file.
Each advertisement in the XML advertisement file can be assigned a category keyword. Use the System.Web.UI.WebControls.AdRotator.KeywordFilter property to filter the advertisements for the specified keyword. Only advertisements containing the keyword will be selected for the System.Web.UI.WebControls.AdRotator control. The System.Web.UI.WebControls.AdRotator.KeywordFilter property can be programmatically set to match the profile of the user.
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
Target
ToString
Description
Gets or sets the name of the browser window or frame that displays the contents of the Web page linked to when the System.Web.UI.WebControls.AdRotator control is clicked.
Use the System.Web.UI.WebControls.AdRotator.Target property to specify the target window or frame that displays the contents of the Web page linked to when the System.Web.UI.WebControls.AdRotator control is clicked. Values must begin with a letter in the range of a to z (case insensitive), except for the following special values, which begin with an underscore: _blank Renders the content in a new, unframed window.
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
ToString
Description
Occurs once per round trip to the server after the creation of the control, but before the page is rendered.
This event is raised once per round trip to the server after the creation of the control, but before the page is rendered.
CreateControlCollection
OnAdCreated
Raises the System.Web.UI.WebControls.AdRotator.AdCreated event for the System.Web.UI.WebControls.AdRotator control.
The System.Web.UI.WebControls.AdRotator.AdCreated event is raised on the server after the System.Web.UI.WebControls.AdRotator control is created, but before the page is rendered. If the System.Web.UI.WebControls.AdRotator.AdvertisementFile property is set, the System.Web.UI.WebControls.AdRotator.AdCreated event is raised after an advertisement has been selected by the System.Web.UI.WebControls.AdRotator control. An System.Web.UI.WebControls.AdCreatedEventArgs that contains event data.
OnPreRender
Gets the advertisement information for rendering by looking up the file data and/or calling the user event.
Randomly picks an advertisement based on the impresssion (weight) value of the advertisement.
Render
Displays the System.Web.UI.WebControls.AdRotator on the client.
Displays an image obtained from the ad chosen in System.Web.UI.WebControls.AdRotator.OnPreRender(System.EventArgs). A System.Web.UI.HtmlTextWriter that contains the output stream to render on the client.
BaseCompareValidator class (System.Web.UI.WebControls)
TrackViewState
Description
Serves as the abstract base class for validation controls that perform comparisons.
The System.Web.UI.WebControls.BaseCompareValidator class is inherited by validation controls that compare values, such as the System.Web.UI.WebControls.CompareValidator and System.Web.UI.WebControls.RangeValidator controls.
BaseCompareValidator
Example Syntax:
TrackViewState
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
ControlToValidate
CssClass
CutoffYear
TrackViewState
Description
Gets the maximum year that can be represented by a two-digit year.
Use the System.Web.UI.WebControls.BaseCompareValidator.CutoffYear property to determine the maximum year that can be represented by a two-digit year in a 100 year range. For example, if this property contains the value 2029, you can represent the years 1930 to 2029 by using a two-digit year. The two-digit year 30 is interpreted as 1930, while 29 is interpreted as 2029. You cannot change the value of this property directly, however you can change the maximum year that can be represented by a two-digit year by setting the System.Globalization.Calendar.TwoDigitYearMax property.
Display
EnableClientScript
Enabled
EnableViewState
ErrorMessage
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
IsValid
NamingContainer
Page
Parent
PropertiesValid
RenderUplevel
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToolTip
Type
TrackViewState
Description
Gets or sets the data type of the values being compared.
Use the System.Web.UI.WebControls.BaseCompareValidator.Type property to specify the data type of the two values being compared. Both values are converted to the specified data type before any comparison is performed.
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
AddAttributesToRender method AddAttributesToRender method
CanConvert
Determines whether the specified string can be converted to the specified data type.
Return Value: true if the specified data string is convertible to the specified data type; otherwise, false.
Use the System.Web.UI.WebControls.BaseCompareValidator.CanConvert(System.String,System.Web.UI.WebControls.ValidationDataType) method to determine whether the specified string can be converted to the specified data type. This method is commonly used to test whether a string can be converted to a compatible data type before performing an operation that depends on that data type. The string to test whether the specified data type conversion is possible. One of the System.Web.UI.WebControls.ValidationDataType enumeration values.
Compare
Compares two strings using the specified operator and validation data type.
Return Value: true if the conversion is successful; otherwise false. The string value on the left side of the operator. The string value on the right side of the operator. A System.Web.UI.WebControls.ValidationCompareOperator object that represents the comparison operation to perform. A System.Web.UI.WebControls.ValidationDataType object that represents the data type of the operands.
Convert
Converts the specified text into an object with specified validation data type.
Return Value: true if the conversion is successful; otherwise false. The source text to convert from. A System.Web.UI.WebControls.ValidationDataType object that represents the data type to convert the text into. A System.Object that contains the conversion result.
DetermineRenderUplevel
Determines whether the validation control can be rendered for an uplevel browser.
Return Value: true if the validation control can be rendered for an uplevel browser; otherwise, false.
GetDateElementOrder
Return the order of date elements for the current culture Return the order of date elements for the current culture
GetFullYear
Generates the four-digit year representation of the specified two-digit year.
Return Value: The four-digit year representation of the specified two-digit year.
Use the System.Web.UI.WebControls.BaseCompareValidator.GetFullYear(System.In t32) method to generate the four-digit year representation of the specified two-digit year. The four-digit year representation depends on the value of the System.Globalization.BaseCompareValidator.CutoffYear property, which contains the maximum year that can be represented by a two-digit year in a 100 year range. For example, if the System.Globalization.BaseCompareValidator.CutoffYear property contains the value 2029, the System.Web.UI.WebControls.BaseCompareValidator.GetFullYear(System.In t32) method returns a year between 1930 to 2029. The two-digit year 30 is interpreted as 1930, while 29 is interpreted as 2029. You can change the maximum year that can be represented by a two-digit year by setting the System.Globalization.Calendar.TwoDigitYearMax property. A two-digit year.
BaseDataList class (System.Web.UI.WebControls)
Validate
Description
Serves as the abstract base class for data list controls, such as the System.Web.UI.WebControls.DataList and System.Web.UI.WebControls.DataGrid controls. This class provides methods and properties that are common to all data list controls.
The System.Web.UI.WebControls.BaseDataList class provides the common functionality for all data list controls, such as the System.Web.UI.WebControls.DataList and System.Web.UI.WebControls.DataGrid controls. An instance of this class is not created directly. Instead, data list controls inherit the methods and properties common to all data list controls from this class.
BaseDataList
Example Syntax:
Validate
Initializes a new instance of the System.Web.UI.WebControls.BaseDataList class.
A System.Web.UI.WebControls.BaseDataList object is not created directly. This constructor is commonly called in the constructor of a derived class to initialize the properties defined in the System.Web.UI.WebControls.BaseDataList class.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
CellPadding
Validate
Description
Gets or sets the amount of space between the contents of a cell and the cell's border.
Use the System.Web.UI.WebControls.BaseDataList.CellPadding property to control the spacing between the contents of a cell and the cell's border. The padding amount specified is added to all four sides of a cell. All cells in the same column of the list control share the same cell width. Therefore, if the content of one cell is longer than the content other cells in the same column, the padding amount is applied to the width of longest cell. All other cells in the column will also share the same cell width. The same is true for all cells in the same row. The padding amount is applied to the tallest cell in the row, with all cells in the same row sharing the same cell height. Individual cell sizes cannot be specified.
CellSpacing
Validate
Gets or sets the amount of space between cells.
Use the System.Web.UI.WebControls.BaseDataList.CellSpacing property to control the spacing between adjacent cells in the list control. This spacing is applied both vertically and horizontally.
ChildControlsCreated
ClientID
Context
Controls
Validate
Description
ControlStyle
ControlStyleCreated
CssClass
DataKeyField
Validate
Description
Gets or sets the primary key field in the data source referenced by System.Web.UI.WebControls.BaseDataList.DataSource.
DataKeys
Validate
Gets a collection that stores the primary key values of each record (displayed as a row) in the list control.
Use the System.Web.UI.WebControls.BaseDataList.DataKeyCollection to access the primary key values of each record (displayed as a row) in the list control. This property is commonly used to include the primary key field with the list control without displaying it in the control. The collection is filled with the values from the field specified by the System.Web.UI.WebControls.BaseDataList.DataKeyField property.
DataKeysArray
Validate
Gets a list of key fields in the data source.
DataMember
Validate
Gets or sets the specific data member in a multi member System.Web.UI.WebControls.BaseDataList.DataSource to bind to the list control.
Use the System.Web.UI.WebControls.BaseDataList.DataMember property to specify a member from a multi member System.Web.UI.WebControls.BaseDataList.DataSource to bind to the list control. For example, if you had a System.Web.UI.WebControls.BaseDataList.DataSource that contains multiple tables, you can use the System.Web.UI.WebControls.BaseDataList.DataMember property to specify the table to bind to the list control.
DataSource
Validate
Gets or sets the source to a list of values used to populate the items within the control.
Lists derived from ICollection can also be used as a DataSource.
Enabled
EnableViewState
Events
Font
ForeColor
GridLines
Validate
Description
Gets or sets a value that specifies the grid line style.
HasChildViewState
Height
HorizontalAlign
Validate
Description
Gets or sets the horizontal alignment of the control within its container.
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
Validate
Description
Occurs when an item on the list is selected.
AddParsedSubObject
Overridden. The object to add.
CreateChildControls
Creates a child control using the view state.
CreateControlHierarchy
Overridden. true to use the System.Web.UI.WebControls.BaseDataList.DataSource; otherwise, false.
DataBind
Binds the control and all of its child controls to the data source specified by the System.Web.UI.WebControls.BaseDataList.DataSource property.
IsBindableType
Determines whether the specified data type is bindable to a list control that derives from the System.Web.UI.WebControls.BaseDataList class.
Return Value: true if the specified data type is bindable to a list control that derives from the System.Web.UI.WebControls.BaseDataList class; otherwise, false.
Use the System.Web.UI.WebControls.BaseDataList.IsBindableType(System.Type) static method to determine whether the specified data type is bindable to a list control that inherits from the System.Web.UI.WebControls.BaseDataList class. The supported data types are System.Boolean, System.Byte, System.SByte, System.Int16, System.UInt16, System.Int32, System.UInt32 , System.Int64, System.UInt64, System.Char, System.Double, System.Single, System.DateTime, System.Decimal, and string. A System.Type object that contains the data type to test.
OnDataBinding
Raises the DataBinding event of a System.Web.UI.WebControls.BaseDataList.
The event is raised when data is bound to the control. An System.EventArgs that contains the event data.
OnSelectedIndexChanged
Raises the System.Web.UI.WebControls.BaseDataList.SelectedIndexChanged event of a System.Web.UI.WebControls.BaseDataList. An System.EventArgs that contains the event data.
PrepareControlHierarchy
Overridden.
Render
Displays the control on the client. An System.Web.UI.HtmlTextWriter that contains the output stream to render on the client.
BaseValidator class (System.Web.UI.WebControls)
TrackViewState
Description
Serves as the abstract base class for validation controls.
The System.Web.UI.WebControls.BaseValidator class provides the core implementation for all validation controls.
BaseValidator
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.BaseValidator class.
This constructor is not called directly. Validation controls that inherit from this class can call this constructor from their own constructors to initialize the base properties.
AccessKey
Attributes
BackColor
Border Color
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
ControlToValidate
TrackViewState
Description
Gets or sets the input control to validate.
Use the System.Web.UI.WebControls.BaseValidator.ControlToValidate property to specify the input control to validate. This property must be set to the ID of an input control for all validation controls except for the System.Web.UI.WebControls.CustomValidator control, which can be left blank. If you do not specify a valid input control, an exception will be thrown when the page is rendered. The ID must refer to a control within the same container as the validation control. It must be in the same page or user control, or it must be in the same template of a templated control.
CssClass
Display
TrackViewState
Description
Gets or sets the display behavior of the error message in a validation control.
Use the System.Web.UI.WebControls.BaseValidator.Display property to specify the display behavior of the error message in the validation control. The following table lists the different values that can be used.
EnableClientScript
TrackViewState
Gets or sets a value indicating whether client-side validation is enabled.
Use the System.Web.UI.WebControls.BaseValidator.EnableClientScript property to specify whether client-side validation is enabled.
Enabled
TrackViewState
Gets or sets a value that indicates whether the validation control is enabled.
Use the System.Web.UI.WebControls.BaseValidator.Enabled property to specify whether the validation control is enabled. You can programmatically disable the validation control by setting this property to false.
EnableViewState
ErrorMessage
TrackViewState
Description
Gets or sets the text for the error message.
Use the System.Web.UI.WebControls.BaseValidator.ErrorMessage property to specify the text to display in the validation control when validation fails. This text is also included in the System.Web.UI.WebControls.ValidationSummary control, if one is placed on the Web page.
Events
Font
ForeColor
TrackViewState
Description
Gets or sets the color of the message displayed when validation fails.
Use the System.Web.UI.WebControls.BaseValidator.ForeColor property to specify a custom text color for the message displayed when validation fails.
HasChildViewState
Height
ID
IsTrackingViewState
IsValid
TrackViewState
Description
Gets or sets a value that indicates whether the associated input control passes validation.
Use the System.Web.UI.WebControls.BaseValidator.IsValid property to determine whether the associated input control passes validation.
NamingContainer
Page
Parent
PropertiesValid
TrackViewState
Description
Gets a value that indicates whether the control specified by the System.Web.UI.WebControls.BaseValidator.ControlToValidate property is a valid control.
Use the System.Web.UI.WebControls.BaseValidator.PropertiesValid property to determine whether the System.Web.UI.WebControls.BaseValidator.ControlToValidate property contains a valid input control. To be a valid input control, the System.Web.UI.WebControls.BaseValidator.ControlToValidate property must set to a control on the page.
RenderUplevel
TrackViewState
Gets a value that indicates whether the client's browser supports uplevel rendering.
Use the System.Web.UI.WebControls.BaseValidator.RenderUplevel property to determine whether the client's browser supports uplevel rendering. For a browser to support uplevel rendering, it must support Microsoft XML Document Object Model (DOM) version 4 or higher and any version of ECMAScript.
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
Adds the attributes of this control to the output stream for rendering on the client. An System.Web.UI.HtmlTextWriter that contains the output stream to render on the client.
CheckControlValidationProperty
Helper function that verifies whether the specified control is on the page and contains validation properties.
The System.Web.UI.WebControls.BaseValidator.CheckControlValidationProperty(System.String,System.String) method is a helper function primarily used by the System.Web.UI.WebControls.BaseValidator.ControlPropertiesValid method to verify whether the specified control is on the page and contains validation properties. This method does not return a value to report the result. Instead, it throws an exception when verification fails. The control to verify. The property that contains the control name.
ControlPropertiesValid
Helper function that determines whether the control specified by the System.Web.UI.WebControls.BaseValidator.ControlToValidate property is a valid control.
Return Value: true if the control specified by the System.Web.UI.WebControls.BaseValidator.ControlToValidate property is a valid control; otherwise, false.
The System.Web.UI.WebControls.BaseValidator.ControlPropertiesValid method is a helper function primarily used by the System.Web.UI.WebControls.BaseValidator.PropertiesValid property to determine whether the System.Web.UI.WebControls.BaseValidator.ControlToValidate property contains a valid input control. To be a valid input control, the System.Web.UI.WebControls.BaseValidator.ControlToValidate property must be set to some value and that value must be a control on the page.
DetermineRenderUplevel
Helper function that determines whether the validator control can be rendered for an uplevel browser.
Return Value: true if the validator control can be rendered for an uplevel browser; otherwise, false.
The System.Web.UI.WebControls.BaseValidator.DetermineRenderUplevel method is a helper function used primarily by the System.Web.UI.WebControls.BaseValidator.RenderUplevel property to determine whether the client's browser supports uplevel rendering. For a browser to support uplevel rendering, it must support Microsoft XML Document Object Model (DOM) version 4 or higher and any version of ECMAScript.
EvaluateIsValid
When overridden in a derived class, this method contains the code to determine whether the value in the input control is valid.
Return Value: true if the value in the input control is valid; otherwise, false.
Use the System.Web.UI.WebControls.BaseValidator.EvaluateIsValid method to determine whether the value in the input control specified by the System.Web.UI.WebControls.BaseValidator.ControlToValidate property is valid.
GetControlRenderID
Gets the client ID of the specified control.
Return Value: The client ID of the specified control.
Use the System.Web.UI.WebControls.BaseValidator.GetControlRenderID(System.String) method to get the client ID of the specified control. The name of the control to get the client ID.
GetControlValidationValue
Gets the value associated with the specified input control.
Return Value: The value associated with the specified input control.
Use the System.Web.UI.WebControls.BaseValidator.GetControlValidationValue(System.String) method to get the value associated with the specified input control, regardless of the control type. For example, you can use this method to get the value in a System.Web.UI.WebControls.TextBox control, as well as the value of the selected item from a System.Web.UI.WebControls.ListBox control. The name of the input control to get the value from.
GetValidationProperty
Helper function to get the validation property of a control (if it exists).
Return Value: A System.ComponentModel.PropertyDescriptor that contains the validation property of the control.
The System.Web.UI.WebControls.BaseValidator.GetValidationProperty(System.Object) method is a helper function that gets the validation property of the specified input control. An System.Object that represents the control to get the validation property of.
OnInit
Registers the validator on the page. An System.EventArgs that contains the event data.
OnPreRender
Checks the client brower and configures the validator for compatibility prior to rendering.
OnUnload
Un-registers the validator on the page.
RegisterValidatorCommonScript
Registers code on the page for client-side validation.
Use the System.Web.UI.WebControls.BaseValidator.RegisterValidatorCommonScript method to register code on the page to perform client-side validation.
RegisterValidatorDeclaration
Registers an ECMAScript array declaration using the array name, Page_Validators.
Use the System.Web.UI.WebControls.BaseValidator.RegisterValidatorDeclaration method to register an ECMAScript array declaration using the array name, Page_Validators.
Render
Displays the control on the client. An System.Web.UI.HtmlTextWriter that contains the output stream for rendering on the client.
Validate
Performs validation on the associated input control and updates the System.Web.UI.WebControls.BaseValidator.IsValid property.
Use the System.Web.UI.WebControls.BaseValidator.Validate method to perform validation on the associated input control. This method allows you to programmatically perform validation on the input control. The System.Web.UI.WebControls.BaseValidator.IsValid property is automatically updated with the validation results.
BorderStyle enumeration (System.Web.UI.WebControls)
Validate
Description
Specifies the border style of a control.
The System.Web.UI.WebControls.BorderStyle enumeration represents the different border style options for a control.
Validate
A dashed line border.
Validate
A dotted line border.
Validate
A double solid line border.
Validate
A grooved border for a sunken border appearance.
Validate
An inset border for a sunken control appearance.
Validate
No border.
Validate
No set border style.
Validate
An outset border for a raised control appearance.
Validate
A ridged border for a raised border appearance.
Validate
A solid line border.
BoundColumn class (System.Web.UI.WebControls)
ToString
Description
A column type for the System.Web.UI.WebControls.DataGrid control that is bound to a field in a data source.
Use the System.Web.UI.WebControls.BoundColumn column type in a System.Web.UI.WebControls.DataGrid control to display the contents of a field in the data source in a single column. The field is linked to the System.Web.UI.WebControls.BoundColumn, so any updates in the data source are reflected in the corresponding cells of the System.Web.UI.WebControls.DataGrid control.
ToString
Use the System.Web.UI.WebControls.BoundColumn.thisExpr field to represent the “!” string.
BoundColumn
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.BoundColumn class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.BoundColumn class.
DataField
ToString
Gets or sets the field name from the data source to bind to the System.Web.UI.WebControls.BoundColumn.
Use the System.Web.UI.WebControls.BoundColumn.DataField property to specify the field to bind to the System.Web.UI.WebControls.BoundColumn.
DataFormatString
ToString
Gets or sets the string that specifies the display format for items in the column.
Use the System.Web.UI.WebControls.BoundColumn.DataFormatString property to provide a custom format for the items in the column.
DesignMode
FooterStyle
FooterText
HeaderImageUrl
HeaderStyle
HeaderText
IsTrackingViewState
ItemStyle
Owner
ReadOnly
ToString
Description
Gets or sets a value that indicates whether the items in the System.Web.UI.WebControls.BoundColumn can be edited.
Use the System.Web.UI.WebControls.BoundColumn.ReadOnly property to specify whether the items in the System.Web.UI.WebControls.BoundColumn can be edited. This property can also be used to programmatically determine whether the column is read-only.
SortExpression
ViewState
Visible
FormatDataValue
Converts the specified value to the format indicated by the System.Web.UI.WebControls.BoundColumn.DataFormatString property.
Return Value: The specified value converted to the format indicated by the System.Web.UI.WebControls.BoundColumn.DataFormatString property.
Use the System.Web.UI.WebControls.BoundColumn.FormatDataValue(System.Object) method to convert the specified value to the format indicated by the System.Web.UI.WebControls.BoundColumn.DataFormatString property. The value to format.
Initialize
Resets the System.Web.UI.WebControls.BoundColumn to its initial state.
Use the System.Web.UI.WebControls.BoundColumn.Initialize method to reset the System.Web.UI.WebControls.BoundColumn to its initial state.
InitializeCell
Resets the specified cell in the System.Web.UI.WebControls.BoundColumn to its initial state.
The System.Web.UI.WebControls.BoundColumn.InitializeCell(System.Web.UI.WebControls.TableCell,System.Int32,System.Web.UI.WebControls.ListItemType) method resets the specified cell in the System.Web.UI.WebControls.BoundColumn to its initial state. A System.Web.UI.WebControls.TableCell object that represents the cell to reset. The column number where the cell is located. One of the System.Web.UI.WebControls.ListItemType values.
Button class (System.Web.UI.WebControls)
TrackViewState
Description
Displays a push button control on the Web page.
Use the System.Web.UI.WebControls.Button control to create a push button on the Web page. You can create either a submit button or a command button.
Button
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.Button class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.Button class.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
CausesValidation
TrackViewState
Description
Gets or sets a value indicating whether validation is performed when the System.Web.UI.WebControls.Button control is clicked.
By default, page validation is performed when a System.Web.UI.WebControls.Button control is clicked. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control.
ChildControlsCreated
ClientID
CommandArgument
TrackViewState
Description
Gets or sets an optional parameter passed to the System.Web.UI.WebControls.Button.Command event along with the associated System.Web.UI.WebControls.Button.CommandName.
Use the System.Web.UI.WebControls.Button.CommandArgument property to specify an parameter that compliments the System.Web.UI.WebControls.Button.CommandName property.
CommandName
TrackViewState
Gets or sets the command name associated with the System.Web.UI.WebControls.Button control that is passed to the System.Web.UI.WebControls.Button.Command event.
When you have multiple System.Web.UI.WebControls.Button controls on a Web page, use the System.Web.UI.WebControls.Button.CommandName property to specify or determine the command name associated with each System.Web.UI.WebControls.Button control. You can set the System.Web.UI.WebControls.Button.CommandName property with any string that identifies the command to perform. You can then programmatically determine the command name of the System.Web.UI.WebControls.Button control and perform the appropriate actions.
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
TrackViewState
Description
Gets or sets the text caption displayed in the System.Web.UI.WebControls.Button control.
Use the System.Web.UI.WebControls.Button.Text property to specify or determine the caption to display in the System.Web.UI.WebControls.Button control.
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
TrackViewState
Description
Occurs when the System.Web.UI.WebControls.Button control is clicked.
The System.Web.UI.WebControls.Button.Click event is raised when the System.Web.UI.WebControls.Button control is clicked. This event is commonly used when no command name is associated with the System.Web.UI.WebControls.Button control (for instance, with a submit button).
TrackViewState
Occurs when the System.Web.UI.WebControls.Button control is clicked.
The System.Web.UI.WebControls.Button.Command event is raised when the System.Web.UI.WebControls.Button control is clicked. This event is commonly used when a command name, such as Sort, is associated with the System.Web.UI.WebControls.Button control. This allows you to create multiple System.Web.UI.WebControls.Button controls on a Web page and programmatically determine which System.Web.UI.WebControls.Button control is clicked.
AddAttributesToRender
Adds the attributes of the System.Web.UI.WebControls.Button control to the output stream for rendering on the client. An System.Web.UI.HtmlTextWriter that contains the output stream to render on the client.
OnClick
Raises the System.Web.UI.WebControls.Button.Click event of the System.Web.UI.WebControls.Button control.
The System.Web.UI.WebControls.Button.Click event is raised when the System.Web.UI.WebControls.Button control is clicked. This event is commonly used when no command name is associated with the System.Web.UI.WebControls.Button control (for instance, with a submit button). A System.EventArgs that contains the event data.
OnCommand
Raises the System.Web.UI.WebControls.Button.Command event of the System.Web.UI.WebControls.Button control.
The System.Web.UI.WebControls.Button.Command event is raised when the System.Web.UI.WebControls.Button control is clicked. This event is commonly used when a command name, such as Sort, is associated with the System.Web.UI.WebControls.Button control. This allows you to create multiple System.Web.UI.WebControls.Button controls on a Web page and programmatically determine which System.Web.UI.WebControls.Button control is clicked. A System.Web.UI.WebControls.CommandEventArgs that contains the event data.
RenderContents
IPostBackEventHandler.RaisePostBackEvent
ButtonColumn class (System.Web.UI.WebControls)
TrackViewState
Description
A column type for the System.Web.UI.WebControls.DataGrid control that contains a user-defined command button, such as Add or Remove, that corresponds with each row in the column.
Use the System.Web.UI.WebControls.ButtonColumn column type in a System.Web.UI.WebControls.DataGrid control to create a command button that corresponds with each row in the System.Web.UI.WebControls.DataGrid control. Specify the caption displayed in the command buttons by setting the System.Web.UI.WebControls.ButtonColumn.Text property.
ButtonColumn
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.ButtonColumn class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.ButtonColumn class.
ButtonType
TrackViewState
Gets or sets the type of button to display in the System.Web.UI.WebControls.ButtonColumn column.
Use this property to specify whether the buttons in the column are displayed as link or push buttons. Clicking on the command buttons in the column raises the System.Web.UI.WebControls.DataGrid.ItemCommand event. You can programmatically control the action performed when the command button is clicked by providing an event handler for the System.Web.UI.WebControls.DataGrid.ItemCommand event.
CommandName
TrackViewState
Gets or sets a string that represents the command to perform when a button in the System.Web.UI.WebControls.ButtonColumn is clicked.
Use the System.Web.UI.WebControls.ButtonColumn.CommandName property to associate a command name, such as Add or Remove, with a button. You can set the System.Web.UI.WebControls.ButtonColumn.CommandName property to any string that identifies the action to perform when the command button is clicked. You can then programmatically determine the command name in the event handler for the System.Web.UI.WebControls.DataGrid.ItemCommand event and perform the appropriate actions.
DataTextField
TrackViewState
Gets or sets the field name from a data source to bind to the System.Web.UI.WebControls.ButtonColumn.
Use the System.Web.UI.WebControls.ButtonColumn.DataTextField property to specify the field name from the data source to bind to the System.Web.UI.WebControls.ButtonColumn.Text property of the buttons in the System.Web.UI.WebControls.ButtonColumn.
DataTextFormatString
TrackViewState
Gets or sets the string that specifies the display format for the caption in each command button.
Use the System.Web.UI.WebControls.ButtonColumn.DataTextFormatString property to provide a custom display format for the caption of the command buttons in the column.
DesignMode
FooterStyle
FooterText
HeaderImageUrl
HeaderStyle
HeaderText
IsTrackingViewState
ItemStyle
Owner
SortExpression
Text
TrackViewState
Description
Gets or sets the caption displayed in the command buttons of the System.Web.UI.WebControls.ButtonColumn.
Use the System.Web.UI.WebControls.ButtonColumn.Text property to specify or determine the caption displayed in the command buttons of the System.Web.UI.WebControls.ButtonColumn.
ViewState
Visible
FormatDataTextValue
Converts the specified value to the format indicated by the System.Web.UI.WebControls.ButtonColumn.DataTextFormatString property.
Return Value: The specified value converted to the format indicated by the System.Web.UI.WebControls.ButtonColumn.DataTextFormatString property.
Use the System.Web.UI.WebControls.ButtonColumn.FormatDataTextValue(System. Object) method to convert the specified value to the format indicated by the System.Web.UI.WebControls.ButtonColumn.DataTextFormatString property. The value to format.
Initialize
Resets the System.Web.UI.WebControls.ButtonColumn to its initial state.
Use the System.Web.UI.WebControls.ButtonColumn.Initialize method to reset the System.Web.UI.WebControls.ButtonColumn to its initial state.
InitializeCell
Initializes a cell in the System.Web.UI.WebControls.ButtonColumn to its initial state.
The System.Web.UI.WebControls.ButtonColumn.InitializeCell(System.Web.UI.WebControls.TableCell,System.Int32,System.Web.UI.WebControls.ListItemType) method resets the specified cell in the System.Web.UI.WebControls.ButtonColumn to its initial state. A System.Web.UI.WebControls.TableCell object that represents the cell to reset. The column number where the cell is located. One of the System.Web.UI.WebControls.ListItemType values.
ButtonColumnType enumeration (System.Web.UI.WebControls)
TrackViewState
Description
Specifies the button type for the System.Web.UI.WebControls.ButtonColumn object.
The System.Web.UI.WebControls.ButtonColumnType enumeration represents the button styles for the System.Web.UI.WebControls.ButtonColumn object.
TrackViewState
A column of hyperlink style buttons.
TrackViewState
A column of push buttons.
Calendar class (System.Web.UI.WebControls)
ToString
Description
Displays a single month calendar that allows the user to select dates and move to the next or previous month.
Use the System.Web.UI.WebControls.Calendar control to display a single month of a calendar on a Web page. The control allows you to select dates and move to the next or previous month. The System.Web.UI.WebControls.Calendar control supports all of the System.Globalization.Calendar types in the System.Globalization namespace. Apart from the Gregorian calendar, this also includes calendars that use different year and month systems, such as the Hjiri calendar.
Calendar
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Calendar class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.Calendar class.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
CellPadding
ToString
Description
Gets or sets the amount of space between the contents of a cell and the cell's border.
Use this property to control the spacing between the contents of a cell and the cell's border. The padding amount specified is added to all four sides of a cell. Individual cell sizes cannot be specified.
CellSpacing
ToString
Gets or sets the amount of space between cells.
Use this property to control the spacing between individual cells in the calendar. This spacing is applied both vertically and horizontally.
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DayHeaderStyle
ToString
Description
Gets the style properties for the section that displays the day of the week.
Use this property to specify the style for the section that displays the days of the week. For additional information on the different style properties that can be controlled, see System.Web.UI.WebControls.TableItemStyle.
DayNameFormat
ToString
Gets or sets the name format of days of the week.
Use the System.Web.UI.WebControls.Calendar.DayNameFormat property to specify the name format for the days of the week. This property is set with one of the System.Web.UI.WebControls.DayNameFormat enumeration values. You can specify whether the days of the week are displayed as the full name, short (abbreviated) name, first letter of the day, or first two letters of the day.
DayStyle
ToString
Gets the style properties for the days in the displayed month.
Use this property to specify the style for the days in the displayed month.
Enabled
EnableViewState
Events
FirstDayOfWeek
ToString
Description
Gets or sets the day of the week to display in the first day column of the System.Web.UI.WebControls.Calendar control.
Use the System.Web.UI.WebControls.Calendar.FirstDayOfWeek property to specify the day of the week to display in the first day column of the System.Web.UI.WebControls.Calendar control. This property is set with one of the System.Web.UI.WebControls.FirstDayOfWeek enumeration values. You can specify any day of the week or FirstDayOfWeek.Default, which indicates that the date is determined by the system settings.
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
NamingContainer
NextMonthText
ToString
Description
Gets or sets the text displayed for the next month navigation control.
Use the System.Web.UI.WebControls.Calendar.NextMonthText property to provide custom text for the next month navigation control. This property is commonly used along with the System.Web.UI.WebControls.Calendar.PrevMonthText property to provide a custom set of navigation controls.
NextPrevFormat
ToString
Gets or sets the format of the next and previous month navigation elements in the title section of the System.Web.UI.WebControls.Calendar control.
Use the System.Web.UI.WebControls.Calendar.NextPrevFormat property to specify the format for the next and previous month navigation elements on the System.Web.UI.WebControls.Calendar control. This property is set with one of the System.Web.UI.WebControls.NextPrevFormat enumeration values. You can specify whether the text for the navigation controls is displayed as the full month name, the short (abbreviated) month name, or custom text.
NextPrevStyle
ToString
Gets the style properties for the next and previous month navigation elements.
Use this property to specify the style for the next and previous month navigation elements. For additional information on the different style properties that can be controlled, see System.Web.UI.WebControls.TableItemStyle.
OtherMonthDayStyle
ToString
Gets the style properties for the days on the System.Web.UI.WebControls.Calendar control that are not in the displayed month.
Use this property to specify the style for the days on the System.Web.UI.WebControls.Calendar control that are not in the displayed month. If the System.Web.UI.WebControls.Calendar.OtherMonthDayStyle property is not set, the style specified in the System.Web.UI.WebControls.Calendar.DayStyle property is used.
Page
Parent
PrevMonthText
ToString
Description
Gets or sets the text displayed for the previous month navigation control.
Use the System.Web.UI.WebControls.Calendar.PrevMonthText property to provide custom text for the previous month navigation control. This property is commonly used along with the System.Web.UI.WebControls.Calendar.NextMonthText property to provide a custom set of navigation controls.
SelectedDate
ToString
Gets or sets the selected date.
Use the System.Web.UI.WebControls.Calendar.SelectedDate property to determine the selected date on the System.Web.UI.WebControls.Calendar control. The System.Web.UI.WebControls.Calendar.SelectedDate property is typically used when the System.Web.UI.WebControls.Calendar.SelectionMode property is set to CalendarSelectionMode.Day. This setting only allows a single date selection from the System.Web.UI.WebControls.Calendar control.
SelectedDates
ToString
Gets a collection of System.DateTime objects that represent the selected dates on the System.Web.UI.WebControls.Calendar control.
Use the System.Web.UI.WebControls.Calendar.SelectedDates collection to determine the currently selected dates on the System.Web.UI.WebControls.Calendar control. This property is typically used when the System.Web.UI.WebControls.Calendar.SelectionMode property is set to CalendarSelectionMode.DayWeek or CalendarSelectionMode.DayWeekMonth. These settings allow you to select multiple dates from the System.Web.UI.WebControls.Calendar control by week or month.
SelectedDayStyle
ToString
Gets the style properties for the selected dates.
Use this property to specify the style for the selected dates on the System.Web.UI.WebControls.Calendar control. If the System.Web.UI.WebControls.Calendar.SelectedDayStyle property is not set, the style specified in the System.Web.UI.WebControls.Calendar.DayStyle property is used.
SelectionMode
ToString
Gets or sets the date selection mode on the System.Web.UI.WebControls.Calendar control that specifies whether the user can select a single day, a week, or an entire month.
Use the System.Web.UI.WebControls.Calendar.SelectionMode property to specify the date selection mode on the System.Web.UI.WebControls.Calendar control. This property is set with one of the System.Web.UI.WebControls.CalendarSelectionMode enumeration values. You can specify whether the user can select a single day, a week, or an entire month, or you can disable date selection capability entirely.
SelectMonthText
ToString
Gets or sets the text displayed for the month selection element in the selector column.
Use the System.Web.UI.WebControls.Calendar.SelectMonthText property to provide custom text for the month selection element in the selector column.
SelectorStyle
ToString
Gets the style properties for the week and month selector column.
Use this property to specify the style for the week and month selector column. For additional information on the different style properties that can be controlled, see System.Web.UI.WebControls.TableItemStyle.
SelectWeekText
ToString
Gets or sets the text displayed for the week selection element in the selector column.
Use the System.Web.UI.WebControls.Calendar.SelectWeekText property to provide custom text for the week selection element in the selector column.
ShowDayHeader
ToString
Gets or sets a value indicating whether the heading for the days of the week is displayed.
Use the System.Web.UI.WebControls.Calendar.ShowDayHeader property to specify whether the heading for the days of the week is displayed.
ShowGridLines
ToString
Gets or sets a value indicating whether the days on the System.Web.UI.WebControls.Calendar control are separated with grid lines.
Use the System.Web.UI.WebControls.Calendar.ShowGridLines property to specify whether the days on the System.Web.UI.WebControls.Calendar control are separated with grid lines.
ShowNextPrevMonth
ToString
Gets or sets a value indicating whether the System.Web.UI.WebControls.Calendar control displays the next and previous month navigation elements in the title section.
Use the System.Web.UI.WebControls.Calendar.ShowNextPrevMonth property to specify whether the next and previous month navigation elements are displayed in the title section.
ShowTitle
ToString
Gets or sets a value indicating whether the title section is displayed.
Use the System.Web.UI.WebControls.Calendar.ShowTitle property to specify whether the title section is displayed.
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
TitleFormat
ToString
Description
Gets or sets the title format for the title section.
Use the System.Web.UI.WebControls.Calendar.TitleFormat property to specify the format for the title section. This property is set with one of the System.Web.UI.WebControls.TitleFormat enumeration values. You can specify whether the title displays as the month or both the month and the year.
TitleStyle
ToString
Gets the style properties of the title heading for the System.Web.UI.WebControls.Calendar control.
Use this property to specify the style for the title heading of the System.Web.UI.WebControls.Calendar control. For additional information on the different style properties that can be controlled, see System.Web.UI.WebControls.TableItemStyle.
TodayDayStyle
ToString
Gets the style properties for today's date on the System.Web.UI.WebControls.Calendar control.
Use this property to specify the style for today's date on the System.Web.UI.WebControls.Calendar control. If the System.Web.UI.WebControls.Calendar.TodayDayStyle property is not set, the style specified in the System.Web.UI.WebControls.Calendar.DayStyle property is used.
TodaysDate
ToString
Gets or sets the value for today's date.
Use the System.Web.UI.WebControls.Calendar.TodaysDate property to determine today's date. You can also use this property to programmatically set the value for today's date on the System.Web.UI.WebControls.Calendar control. This property is set using a System.DateTime object.
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
VisibleDate
ToString
Description
Gets or sets the date that specifies the month to display on the System.Web.UI.WebControls.Calendar control.
Use the System.Web.UI.WebControls.Calendar.VisibleDate property to programmatically set the month to display on the System.Web.UI.WebControls.Calendar control. The specified date can be any date in the month you want to display, although it is common to use the first date in the month. This property is set using a System.DateTime object.
WeekendDayStyle
ToString
Gets the style properties for the weekend dates on the System.Web.UI.WebControls.Calendar control.
Use this property to specify the style for the weekend dates on the System.Web.UI.WebControls.Calendar control. If the System.Web.UI.WebControls.Calendar.WeekendDayStyle property is not set, the style specified in the System.Web.UI.WebControls.Calendar.DayStyle property is used.
Width
ToString
Description
Occurs when each day is created in the control hierarchy for the System.Web.UI.WebControls.Calendar control.
This event is raised when each day is created in the control hierarchy for the System.Web.UI.WebControls.Calendar control.
ToString
Description
Occurs when the user selects a day, a week, or an entire month by clicking the date selector controls.
This event is raised when the user selects a day, a week, or an entire month by clicking the date selector controls.
ToString
Description
Occurs when the user clicks on the next or previous month navigation controls on the title heading.
This event is raised when the user clicks on the next or previous month navigation elements on the title heading.
CreateControlCollection
HasWeekSelectors
Determines if a System.Web.UI.WebControls.CalendarSelectionMode contains week selectors.
Return Value: true if the System.Web.UI.WebControls.CalendarSelectionMode contains week selectors; otherwise false.
System.Web.UI.WebControls.CalendarSelectionMode values of DayWeek and DayWeekMonth contains week selectors. One of the System.Web.UI.WebControls.CalendarSelectionMode values.
LoadViewState
Loads a saved state of the System.Web.UI.WebControls.Calendar. An System.Object that contains the saved condition of the System.Web.UI.WebControls.Calendar.
OnDayRender
Raises the System.Web.UI.WebControls.Calendar.DayRender event of the System.Web.UI.WebControls.Calendar control and allows you to provide a custom handler for the System.Web.UI.WebControls.Calendar.DayRender event.
Although databinding is not supported for the System.Web.UI.WebControls.Calendar control, it is possible modify the content and formatting of the individual date cells. Before the System.Web.UI.WebControls.Calendar control is displayed on the Web page, it creates and assembles the components that make up the control. The System.Web.UI.WebControls.Calendar.DayRender event is raised when each date cell in System.Web.UI.WebControls.Calendar control is created. You can control the contents and formatting of a date cell when it is created by providing code in the event handler for the System.Web.UI.WebControls.Calendar.DayRender event. A System.Web.UI.WebControls.TableCell that contains information about the cell to render. A System.Web.UI.WebControls.CalendarDay that contains information about the day to render.
OnSelectionChanged
Raises the System.Web.UI.WebControls.Calendar.SelectionChanged event of the System.Web.UI.WebControls.Calendar control and allows you to provide a custom handler for the System.Web.UI.WebControls.Calendar.SelectionChanged event.
The System.Web.UI.WebControls.Calendar.SelectionChanged event is raised when the user selects a day, a week, or an entire month by clicking the date selector controls.
OnVisibleMonthChanged
Raises the System.Web.UI.WebControls.Calendar.VisibleMonthChanged event of the System.Web.UI.WebControls.Calendar control and allows you to provide a custom handler for the System.Web.UI.WebControls.Calendar.VisibleMonthChanged event.
The System.Web.UI.WebControls.Calendar.VisibleMonthChanged event is raised when the user clicks on the next or previous month navigation elements on the title section. A System.DateTime object that represents the month currently displayed in the System.Web.UI.WebControls.Calendar control. A System.DateTime object that represents the previous month displayed by the System.Web.UI.WebControls.Calendar control.
Render
Displays the System.Web.UI.WebControls.Calendar control on the client. An System.Web.UI.HtmlTextWriter that contains the output stream for rendering on the client.
SaveViewState
Stores the state of the System.Web.UI.WebControls.Calendar.
Return Value: An object that contains the saved state of the System.Web.UI.WebControls.Calendar.
IPostBackEventHandler.RaisePostBackEvent
TrackViewState
Marks the starting point to begin tracking and saving changes to the control as part of the control viewstate.
CalendarDay class (System.Web.UI.WebControls)
TrackViewState
Description
Represents a date in the System.Web.UI.WebControls.Calendar control.
A System.Web.UI.WebControls.CalendarDay object represents a date in the System.Web.UI.WebControls.Calendar control. You can use this class in the System.Web.UI.WebControls.Calendar.DayRender event handler to programmatically access the properties of a date as it is rendered on the System.Web.UI.WebControls.Calendar control. This allows you to determine the properties of the day (such as whether the date is selectable, selected, today's date, or a weekend date) and programmatically control the appearance or behavior of the day.
CalendarDay
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.CalendarDay class.
The following table shows initial property values for an instance of System.Web.UI.WebControls.CalendarDay. A System.DateTime object that contains the date represented by an instance of this class. true to indicate that the date represented by an instance of this class is either a Saturday or a Sunday; otherwise, false. true to indicate that the date represented by an instance of this class is the current date; otherwise, false. true to indicate that the date represented by an instance of this class is selected on the System.Web.UI.WebControls.Calendar control; otherwise, false. true to indicate that the date represented by an instance of this class is in a month other than the displayed month on the System.Web.UI.WebControls.Calendar control; otherwise, false. The day number for the date represented by this class.
Date
TrackViewState
Gets the date represented by an instance of this class. This property is read-only.
Use the System.Web.UI.WebControls.CalendarDay.Date property to programmatically determine the date represented by an instance of this class.
DayNumberText
TrackViewState
Gets the string equivalent of the day number for the date represented by an instance of the System.Web.UI.WebControls.CalendarDay class. This property is read-only.
Use the System.Web.UI.WebControls.CalendarDay.DayNumberText property to determine the string equivalent of the day number for the date represented by an instance of this class. This allows you to programmatically control the appearance or behavior of the day, based on this value.
IsOtherMonth
TrackViewState
Gets a value that indicates whether the date represented by an instance of this class is in a month other than the month displayed in the System.Web.UI.WebControls.Calendar control. This property is read-only.
Use the System.Web.UI.WebControls.CalendarDay.IsOtherMonth property to programmatically determine whether the date represented by an instance of this class is in a month other than the month displayed in the System.Web.UI.WebControls.Calendar control. This allows you to programmatically control the appearance or behavior of the day based on this value.
IsSelectable
TrackViewState
Gets or sets a value that indicates whether the date represented by an instance of this class can be selected in the System.Web.UI.WebControls.Calendar control.
Use the System.Web.UI.WebControls.CalendarDay.IsSelectable property to specify or determine whether the date represented by an instance of this class can be selected in the System.Web.UI.WebControls.Calendar control. This allows you to programmatically control the appearance behavior of the day, based on this value.
IsSelected
TrackViewState
Gets a value that indicates whether the date represented by an instance of this class is selected in the System.Web.UI.WebControls.Calendar control. This property is read-only.
Use the System.Web.UI.WebControls.CalendarDay.IsSelected property to programmatically determine whether the date represented by an instance of this class is selected in the System.Web.UI.WebControls.Calendar control. This allows you to programmatically control the appearance or behavior of the day, based on this value.
IsToday
TrackViewState
Gets a value that indicates whether the date represented by an instance of this class is the same date specified by the System.Web.UI.WebControls.Calendar.TodaysDate property of the System.Web.UI.WebControls.Calendar control. This property is read-only.
Use the System.Web.UI.WebControls.CalendarDay.IsToday property to programmatically determine whether the date represented by an instance of this class is the same date specified by the System.Web.UI.WebControls.Calendar.TodaysDate property of the System.Web.UI.WebControls.Calendar control. This allows you to programmatically control the appearance or behavior of the day, based on this value.
IsWeekend
TrackViewState
Gets a value that indicates whether the date represented by an instance of this class is a either Saturday or Sunday. This property is read-only.
Use the System.Web.UI.WebControls.CalendarDay.IsWeekend property to programmatically determine whether the date represented by an instance of this class is either a Saturday or a Sunday. This allows you to programmatically control the appearance or behavior of the day, based on this value.
CalendarSelectionMode enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the date selection mode of the System.Web.UI.WebControls.Calendar control.
The System.Web.UI.WebControls.CalendarSelectionMode enumeration represents the date selection modes of the System.Web.UI.WebControls.Calendar control.
ToString
A single date can be selected on the System.Web.UI.WebControls.Calendar control.
ToString
A single day or entire week can be selected on the System.Web.UI.WebControls.Calendar control.
ToString
A single date, week, or entire month can be selected on the System.Web.UI.WebControls.Calendar control.
ToString
No dates can be selected on the System.Web.UI.WebControls.Calendar control.
TableRow.CellControlCollection class (System.Web.UI.WebControls)
ToString
Description
Count
IsReadOnly
IsSynchronized
Item
Owner
SyncRoot
Add
Adds the specified System.Web.UI.Control object to the collection. The new control is added to the end of the array.
AddAt
Adds the specified System.Web.UI.Control object to the collection. The new control is added to the array at the specified index location. The location in the array to add the child control. The Control object to add to the collection.
CheckBox class (System.Web.UI.WebControls)
ToString
Description
Displays a check box that allows the user to select a true or false condition.
Use the System.Web.UI.WebControls.CheckBox control to allow the user to select a true or false state.
CheckBox
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.CheckBox class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.CheckBox class.
AccessKey
Attributes
AutoPostBack
ToString
Description
Gets or sets a value indicating whether the System.Web.UI.WebControls.CheckBox state automatically posts back to the server when clicked.
Use this property to specify whether the state of the System.Web.UI.WebControls.CheckBox control is posted back to the server when clicked.
BackColor
BorderColor
BorderStyle
BorderWidth
Checked
ToString
Description
Gets or sets a value indicating whether the System.Web.UI.WebControls.CheckBox control is checked.
Use this property to determine whether the System.Web.UI.WebControls.CheckBox control is checked. This property can also be used to programmatically set the state of the System.Web.UI.WebControls.CheckBox control.
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToString
Description
Gets or sets the text label associated with the System.Web.UI.WebControls.CheckBox.
Use this property to specify the text label associated with the System.Web.UI.WebControls.CheckBox control. This property can also be used to programmatically get the text label associated with the System.Web.UI.WebControls.CheckBox control.
TextAlign
ToString
Gets or sets the alignment of the text label associated with the System.Web.UI.WebControls.CheckBox control.
Use this property to specify the alignment of the text label associated with the System.Web.UI.WebControls.CheckBox control. You can specify whether the text label appears to the right or left of the check box. Use the System.Web.UI.WebControls.CheckBox.Text property to specify the label text.
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
ToString
Description
Occurs when the System.Web.UI.WebControls.CheckBox.Checked property is changed.
The System.Web.UI.WebControls.CheckBox.CheckedChanged event is raised when the System.Web.UI.WebControls.CheckBox.Checked property is changed.
OnCheckedChanged
Raises the System.Web.UI.WebControls.CheckBox.CheckedChanged event of the System.Web.UI.WebControls.CheckBox control. This allows you to handle the event directly.
The System.Web.UI.WebControls.CheckBox.CheckedChanged event is raised when the System.Web.UI.WebControls.CheckBox.Checked property is changed. A System.EventArgs that contains the event data.
OnPreRender
Registers client script for generating postback prior to rendering on the client if System.Web.UI.WebControls.CheckBox.AutoPostBack is true.
Render
Displays the System.Web.UI.WebControls.CheckBox on the client. A System.Web.UI.HtmlTextWriter that contains the output stream to render on the client.
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
CheckBoxList class (System.Web.UI.WebControls)
TrackViewState
Description
Creates a multi selection check box group that can be dynamically created by binding the control to a data source.
The System.Web.UI.WebControls.CheckBoxList control provides a multi selection check box group that can be dynamically generated with data binding. It contains an System.Web.UI.WebControls.ListControl.Items collection with members that correspond to individual items in the list. To determine which items are checked, loop through and test the System.Web.UI.WebControls.ListItem.Selected property of each item in the list.
CheckBoxList
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.CheckBoxList class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.CheckBoxList class.
AccessKey
Attributes
AutoPostBack
BackColor
BorderColor
BorderStyle
BorderWidth
CellPadding
TrackViewState
Description
Gets or sets the distance (in pixels) between the border and contents of the cell.
Use this property to control the spacing between the contents of a cell and the cell's border in the System.Web.UI.WebControls.CheckBoxList control.
CellSpacing
TrackViewState
Gets or sets the distance (in pixels) between cells.
Use this property to control the spacing between individual cells in the System.Web.UI.WebControls.CheckBoxList control. This property is applied both vertically and horizontally.
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DataMember
DataSource
DataTextField
DataTextFormatString
DataValueField
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
Items
NamingContainer
Page
Parent
RepeatColumns
TrackViewState
Description
Gets or sets the number of columns to display in the System.Web.UI.WebControls.CheckBoxList control.
Use this property to specify the number of columns that display items in the System.Web.UI.WebControls.CheckBoxList control. If this property is not set, the System.Web.UI.WebControls.CheckBoxList control displays all list items in a single column.
RepeatDirection
TrackViewState
Gets or sets a value that indicates whether the control displays vertically or horizontally.
Use this property to specify the display direction of the System.Web.UI.WebControls.CheckBoxList control.
RepeatLayout
TrackViewState
Gets or sets the layout of the check boxes.
Use this property to specify whether the items in the System.Web.UI.WebControls.CheckBoxList control are displayed in a table. If this property is set to RepeatLayout.Table, the items in the list are displayed in a table. If this property is set to RepeatLayout.Flow, the items in the list are displayed without a table structure.
SelectedIndex
SelectedItem
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
TextAlign
TrackViewState
Description
Gets or sets the text alignment for the check boxes within the group.
Use this property to specify whether the text associated with the check boxes appears on the left or right of the check box. If this property is set to TextAlign.Right, the text is displayed to the right of the check box. If this property is set to TextAlign.Left, the text is displayed to the left of the check box.
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
CreateControlStyle
Creates a new control style object.
Return Value: A System.Web.UI.WebControls.Style that contains the style properties of a control.
FindControl
Catches post data for each System.Web.UI.WebControls.CheckBox in the list.
OnPreRender
Configures the System.Web.UI.WebControls.CheckBoxList prior to rendering on the client.
Render
Displays the System.Web.UI.WebControls.CheckBoxList on the client. A System.Web.UI.HtmlTextWriter that contains the output stream for rendering on the client.
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
IRepeatInfoUser. GetItemStyle
IRepeatInfoUser.RenderItem
CommandEventArgs class (System.Web.UI.WebControls)
TrackViewState
Description
Provides data for the Command event.
The Command event is raised when a System.Web.UI.WebControls.Button or System.Web.UI.WebControls.ImageButton control is clicked.
CommandEventArgs
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.CommandEventArgs class with another System.Web.UI.WebControls.CommandEventArgs object.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.CommandEventArgs class using the specified System.Web.UI.WebControls.CommandEventArgs object. A System.Web.UI.WebControls.CommandEventArgs that contains the event data.
CommandEventArgs
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.CommandEventArgs class with the specified command name and argument.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.CommandEventArgs class using the specified command name and argument. The name of the command. A System.Object that contains the arguments for the command.
CommandArgument
TrackViewState
Gets the argument for the command.
The System.Web.UI.WebControls.CommandEventArgs.CommandArgument can contain any string set by the programmer. The System.Web.UI.WebControls.CommandEventArgs.CommandArgument property complements the System.Web.UI.WebControls.CommandEventArgs.CommandName property by allowing you to provide any additional information for the command. For example, you can set the System.Web.UI.WebControls.CommandEventArgs.CommandName property to Sort and set the System.Web.UI.WebControls.CommandEventArgs.CommandArgument property to Ascending to specify a command to sort in ascending order.
CommandName
TrackViewState
Gets the name of the command.
Use the System.Web.UI.WebControls.CommandEventArgs.CommandName property to determine the command to perform. The System.Web.UI.WebControls.CommandEventArgs.CommandName property can contain any string set by the programmer. The programmer can then identify the command name in code and perform the appropriate tasks.
CommandEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the Command event. The source of the event. A System.Web.UI.WebControls.CommandEventArgs that contains the event data.
The Command event is raised when a System.Web.UI.WebControls.Button or System.Web.UI.WebControls.ImageButton control is clicked.
CompareValidator class (System.Web.UI.WebControls)
ToString
Description
Compares the value entered by the user into an input control with the value entered into another input control or a constant value.
Use the System.Web.UI.WebControls.CompareValidator control to compare the value entered by the user into an input control, such as a System.Web.UI.WebControls.TextBox control, with the value entered into another input control or a constant value. You can also use the System.Web.UI.WebControls.CompareValidator control to indicate whether the value entered into an input control can be converted to the data type specified by the System.Web.UI.WebControls.BaseCompareValidator.Type property.
CompareValidator
Example Syntax:
ToString
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
ControlToCompare
ToString
Description
Gets or sets the input control to compare with the input control being validated.
Use the System.Web.UI.WebControls.CompareValidator.ControlToCompare property to specify an input control, such as a System.Web.UI.WebControls.TextBox, to compare with the input control being validated. If the input control specified by this property is not a control on the page, an exception is thrown.
ControlToValidate
CssClass
Display
EnableClientScript
Enabled
EnableViewState
ErrorMessage
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
IsValid
NamingContainer
Operator
ToString
Description
Gets or sets the comparison operation to perform.
Use the System.Web.UI.WebControls.CompareValidator.Operator property to specify the comparison operation to perform. The following table lists the comparison operations that are possible.
Page
Parent
PropertiesValid
RenderUplevel
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToolTip
Type
UniqueID
ValueToCompare
ToString
Description
Gets or sets a constant value to compare with the value entered by the user into the input control being validated.
Use the System.Web.UI.WebControls.CompareValidator.ValueToCompare property to specify a constant value to compare with the value entered by the user into the input control being validated. If the constant value specified by this property fails to convert to the data type specified by the System.Web.UI.WebControls.BaseCompareValidator.Type property, a exception is thrown.
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
Adds the attributes of this control to the output stream for rendering on the client. A System.Web.UI.HtmlTextWriter that contains the output stream for rendering on the client.
ControlPropertiesValid
Checks the properties of a the control for valid values.
Return Value: true if the control properties are valid; otherwise false.
EvaluateIsValid
EvaluateIsValid method EvaluateIsValid method
CustomValidator class (System.Web.UI.WebControls)
Validate
Description
Performs user-defined validation on an input control.
Use the System.Web.UI.WebControls.CustomValidator control to provide a user-defined validation function for an input control. The System.Web.UI.WebControls.CustomValidator control is separated from the input control it validates, which allows you to control where the validation message is displayed.
CustomValidator
Example Syntax:
Validate
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
ClientValidationFunction
Validate
Description
Gets or sets the name of the custom client-side script function used for validation.
Set this property to the name of the function that performs the client-side validation.
Context
Controls
ControlStyle
ControlStyleCreated
ControlToValidate
CssClass
Display
EnableClientScript
Enabled
EnableViewState
ErrorMessage
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
IsValid
NamingContainer
Page
Parent
PropertiesValid
RenderUplevel
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
Validate
Description
Occurs when validation is performed on the server.
The System.Web.UI.WebControls.CustomValidator.ServerValidate event is raised when validation is performed on the server. This event is used to provide a custom validation routine for an input control, such as a System.Web.UI.WebControls.TextBox control.
AddAttributesToRender
Adds the properties of the System.Web.UI.WebControls.CustomValidator control to the output stream for rendering on the client. A System.Web.UI.HtmlTextWriter that contains the output stream for rendering on the client.
ControlPropertiesValid
Checks the properties of the control for valid values.
Return Value: true if the control properties are valid; otherwise false.
EvaluateIsValid
EvaluateIsValid method EvaluateIsValid method
OnServerValidate
Raises the System.Web.UI.WebControls.CustomValidator.ServerValidate event for the System.Web.UI.WebControls.CustomValidator control.
The System.Web.UI.WebControls.CustomValidator.ServerValidate event is raised when validation is performed on the server. The value to validate.
DataGrid class (System.Web.UI.WebControls)
Validate
Description
A data bound list control that displays the items from data source in a table. The System.Web.UI.WebControls.DataGrid control allows you to select, sort, and edit these items.
Use the System.Web.UI.WebControls.DataGrid control to display the fields of a data source as columns in a table. Each row in the System.Web.UI.WebControls.DataGrid control represents a record in the data source. The System.Web.UI.WebControls.DataGrid control supports selection, editing, deleting, paging, and sorting.
Validate
Represents the Cancel command name. This field is read-only.
Use the System.Web.UI.WebControls.DataGrid.CancelCommandName field to represent the Cancel command name.
Validate
Represents the Delete command name. This field is read-only.
Use the System.Web.UI.WebControls.DataGrid.DeleteCommandName field to represent the Delete command name.
Validate
Represents the Edit command name. This field is read-only.
Use the System.Web.UI.WebControls.DataGrid.EditCommandName field to represent the Edit command name.
Validate
Represents the Next command argument. This field is read-only.
Use the System.Web.UI.WebControls.DataGrid.NextPageCommandArgument field to represent the Next command argument.
Validate
Represents the Page command name. This field is read-only.
Use the System.Web.UI.WebControls.DataGrid.PageCommandName field to represent the Page command name.
Validate
Represents the Prev command argument. This field is read-only.
Use the System.Web.UI.WebControls.DataGrid.PrevPageCommandArgument field to represent the Prev command argument.
Validate
Represents the Select command name. This field is read-only.
Use the System.Web.UI.WebControls.DataGrid.SelectCommandName field to represent the Select command name.
Validate
Represents the Sort command name. This field is read-only.
Use the System.Web.UI.WebControls.DataGrid.SortCommandName field to represent the Sort command name.
Validate
Represents the Update command name. This field is read-only.
Use the System.Web.UI.WebControls.DataGrid.UpdateCommandName field to represent the Update command name.
DataGrid
Example Syntax:
Validate
Initializes a new instance of the System.Web.UI.WebControls.DataGrid class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataGrid class.
AccessKey
AllowCustomPaging
Validate
Description
Gets or sets a value that indicates whether custom paging is enabled.
Paging allows you to display the contents of the System.Web.UI.WebControls.DataGrid control in page segments. The number of items on a page is determined by the System.Web.UI.WebControls.DataGrid.PageSize property. If no value is specified for the System.Web.UI.WebControls.DataGrid.PageSize property, the System.Web.UI.WebControls.DataGrid will display 10 items on a page.
AllowPaging
Validate
Gets or sets a value that indicates whether paging is enabled.
Paging allows you to display the contents of the System.Web.UI.WebControls.DataGrid control in page segments. The number of items on a page is determined by the System.Web.UI.WebControls.DataGrid.PageSize property. If no value is specified for the System.Web.UI.WebControls.DataGrid.PageSize property, the System.Web.UI.WebControls.DataGrid control will display 10 items on a page.
AllowSorting
Validate
Gets or sets a value that indicates whether sorting is enabled.
When sorting is enabled, System.Web.UI.WebControls.LinkButton controls are rendered in the heading section of each column where the System.Web.UI.WebControls.DataGridColumn.SortExpression property is set. These System.Web.UI.WebControls.LinkButton controls allow you to sort the System.Web.UI.WebControls.DataGrid control by the selected column. The only exception is when you use a System.Web.UI.WebControls.TemplateColumn column type with the System.Web.UI.WebControls.TemplateColumn.HeaderTemplate property set. In this case, you must provide a System.Web.UI.WebControls.Button control in the System.Web.UI.WebControls.TemplateColumn.HeaderTemplate of the column.
AlternatingItemStyle
Validate
Gets the style properties for alternating items in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGrid.AlternatingItemStyle property to provide a custom style for the alternating items in the System.Web.UI.WebControls.DataGrid control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataGrid control.
Attributes
AutoGenerateColumns
Validate
Description
Gets or sets a value that indicates whether System.Web.UI.WebControls.BoundColumn objects are automatically created and displayed in the System.Web.UI.WebControls.DataGrid control for each field in the data source.
Use this property to automatically create a System.Web.UI.WebControls.BoundColumn object for each field in the data source. Each field is then rendered as a column in the System.Web.UI.WebControls.DataGrid control in the order that the fields appear in the data source.
BackColor
BackImageUrl
Validate
Description
Gets or sets the URL of an image to display in the background of the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGrid.BackImageUrl property to to specify an image to display in the background of the System.Web.UI.WebControls.DataGrid control.
BorderColor
BorderStyle
BorderWidth
CellPadding
CellSpacing
ChildControlsCreated
ClientID
Columns
Validate
Description
Gets a collection of objects that represent the columns of the System.Web.UI.WebControls.DataGrid control.
Use this property to programmatically control the collection of columns in the System.Web.UI.WebControls.DataGrid control. The System.Web.UI.WebControls.DataGrid.Columns collection contains explicitly declared columns that get rendered in the System.Web.UI.WebControls.DataGrid control.
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
CurrentPageIndex
Validate
Description
Gets or sets the index of the currently displayed page.
Use this property to determine the currently displayed page in the System.Web.UI.WebControls.DataGrid control when paging is enabled. This property is also used to programmatically control which page is displayed.
DataKeyField
DataKeys
DataKeysArray
DataMember
DataSource
EditItemIndex
Validate
Description
Gets or sets the index of an item in the System.Web.UI.WebControls.DataGrid control to edit.
When the System.Web.UI.WebControls.DataGrid control contains an System.Web.UI.WebControls.EditCommandColumn object, use this property to determine the index of the item selected in the System.Web.UI.WebControls.DataGrid control to edit.
EditItemStyle
Validate
Gets the style properties of the item selected for editing in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGrid.EditItemStyle property to provide a custom style for the item selected for editing in the System.Web.UI.WebControls.DataGrid control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataGrid control.
Enabled
EnableViewState
Events
Font
FooterStyle
Validate
Description
Gets the style properties of the tooter section in the System.Web.UI.WebControls.DataGrid control.
Use this property to provide a custom style for the tooter of the System.Web.UI.WebControls.DataGrid control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataGrid control.
ForeColor
GridLines
HasChildViewState
HeaderStyle
Validate
Description
Gets the style properties of the heading section in the System.Web.UI.WebControls.DataGrid control.
Use this property to provide a custom style for the heading section of the System.Web.UI.WebControls.DataGrid control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataGrid control.
Height
HorizontalAlign
ID
IsTrackingViewState
Items
Validate
Description
Gets a collection of System.Web.UI.WebControls.DataGridItem objects that represent the individual items in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGrid.Items collection to programmatically control the items in the System.Web.UI.WebControls.DataGrid control. The System.Web.UI.WebControls.DataGrid.Items collection does not provide any methods to add or remove items to the collection. However, you can control the contents of an item by providing a handler for the System.Web.UI.WebControls.DataGrid.ItemCreated event.
ItemStyle
Validate
Gets the style properties of the items in the System.Web.UI.WebControls.DataGrid control.
Use this property to provide a custom style for the items of the System.Web.UI.WebControls.DataGrid control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataGrid control.
NamingContainer
Page
PageCount
Validate
Description
Gets the total number of pages required to display the items in the System.Web.UI.WebControls.DataGrid control.
Use this property to programmatically determine the number of pages required to display the items in the System.Web.UI.WebControls.DataGrid control. This property is only used when the System.Web.UI.WebControls.DataGrid.AllowPaging property is set to true.
PagerStyle
Validate
Gets the style properties of the paging section of the System.Web.UI.WebControls.DataGrid control.
Use this property to provide a custom style for the paging section of the System.Web.UI.WebControls.DataGrid control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataGrid control.
PageSize
Validate
Gets or sets the number of items to display on a single page of the System.Web.UI.WebControls.DataGrid control.
Use this property to specify the number of items to display on a single page of the System.Web.UI.WebControls.DataGrid control. The System.Web.UI.WebControls.DataGrid.AllowPaging property must be set to true for this property have any effect.
Parent
SelectedIndex
Validate
Description
Gets or sets the index of the selected item in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGrid.SelectedIndex property to determine the index of the item selected by the user in the System.Web.UI.WebControls.DataGrid control. You can also use this property to programmatically specify which item is selected in the System.Web.UI.WebControls.DataGrid control.
SelectedItem
Validate
Gets a System.Web.UI.WebControls.DataGridItem object that represents the selected item in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGrid.SelectedIndex property to get a System.Web.UI.WebControls.DataGridItem object that represents the selected item in the System.Web.UI.WebControls.DataGrid control. This object can then be used to access the properties of the selected item.
SelectedItemStyle
Validate
Gets the style properties of the currently selected item in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGrid.SelectedItemStyle property to provide a custom style for the selected item in the System.Web.UI.WebControls.DataGrid control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataGrid control.
ShowFooter
Validate
Gets or sets a value that indicates whether the footer is displayed in the System.Web.UI.WebControls.DataGrid control.
Set this property to true to display the footer in the System.Web.UI.WebControls.DataGrid control. The appearance of the footer is controlled by using the System.Web.UI.WebControls.DataGrid.FooterStyle property.
ShowHeader
Validate
Gets or sets a value that indicates whether the header is displayed in the System.Web.UI.WebControls.DataGrid control.
Set this property to true to display the header in the System.Web.UI.WebControls.DataGrid. The appearance of the header is controlled by using the System.Web.UI.WebControls.DataGrid.HeaderStyle property.
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
VirtualItemCount
Validate
Description
Gets or sets the virtual number of items in the System.Web.UI.WebControls.DataGrid control when custom paging is used.
Use this property to specify the virtual number of items in the System.Web.UI.WebControls.DataGrid control when custom paging is used. This property is only used when the System.Web.UI.WebControls.DataGrid.AllowCustomPaging property is set to true.
Visible
Width
Validate
Description
Occurs when the Cancel button is clicked for an item in the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.DataGrid.CancelCommand event is raised when the Cancel button is clicked for an item in the System.Web.UI.WebControls.DataGrid control.
Validate
Description
Occurs when the Delete button is clicked for an item in the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.DataGrid.DeleteCommand event is raised when the Delete button is clicked for an item in the System.Web.UI.WebControls.DataGrid control.
Validate
Description
Occurs when the Edit button is clicked for an item in the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.DataGrid.EditCommand event is raised when the Edit button is clicked for an item in the System.Web.UI.WebControls.DataGrid control.
Validate
Description
Occurs when any button is clicked in the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.DataGrid.ItemCommand event is raised when any button is clicked in the System.Web.UI.WebControls.DataGrid control. This event is commonly used to handle buttons controls with a custom CommandName value in the System.Web.UI.WebControls.DataGrid control.
Validate
Occurs on the server when an item in the System.Web.UI.WebControls.DataGrid control is created.
The System.Web.UI.WebControls.DataGrid.ItemCreated event is raised when an item in the System.Web.UI.WebControls.DataGrid control is created, both during round-trips and at data bind time.
Validate
Occurs after an item is data bound to the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.DataGrid.ItemDataBound event is raised after an item is data bound to the System.Web.UI.WebControls.DataGrid control. This event provides you with the last opportunity to access the data item before it is displayed on the client. After this event is raised, the data item is nulled out and no longer available.
Validate
Description
Occurs when one of the page selection elements is clicked.
The System.Web.UI.WebControls.DataGrid.PageIndexChanged event is raised when one of the page selection elements is clicked.
Validate
Description
Occurs when a column is sorted.
The System.Web.UI.WebControls.DataGrid.SortCommand event is raised when a column is sorted.
Validate
Description
Occurs when the Update button is clicked for an item in the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.DataGrid.UpdateCommand event is raised when the Update button for an item is clicked.
CreateColumnSet
Creates the set of columns to be used to build up the control hierarchy. When AutoGenerateColumns is true, the columns are created to match the datasource and are appended to the set of columns defined in the Columns collection. The datasource being used to create the control hierarchy Whether to use the datasource to generate columns automatically or to use saved state.
CreateControlHierarchy
Creates the control hierarchy that is used to render the DataGrid. This is called whenever a control hierarchy is needed and the ChildControlsCreated property is false. The implementation assumes that all the children in the controls collection have already been cleared. Whether to use the datasource to generate columns automatically or to use saved state.
CreateControlStyle
Creates new control style.
Return Value: A System.Web.UI.WebControls.Style the represents the new style.
CreateItem
InitializeItem
InitializePager
Creates a DataGridItem that contains the paging UI. The paging UI is a navigation bar that is a built into a single TableCell that spans across all columns of the DataGrid.
LoadViewState
Loads a saved state of the System.Web.UI.WebControls.DataGrid. A saved state of the System.Web.UI.WebControls.DataGrid.
OnBubbleEvent
The source of the event. An System.EventArgs that contains event data.
OnCancelCommand
Raises the System.Web.UI.WebControls.DataGrid.CancelCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataGrid.OnCancelCommand(System.Web.UI.WebControls.DataGridCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataGrid.CancelCommand event. A System.Web.UI.WebControls.DataGridCommandEventArgs that contains event data.
OnDeleteCommand
Raises the System.Web.UI.WebControls.DataGrid.DeleteCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataGrid.OnDeleteCommand(System.Web.UI.WebControls.DataGridCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataGrid.DeleteCommand event. A System.Web.UI.WebControls.DataGridCommandEventArgs that contains event data.
OnEditCommand
Raises the System.Web.UI.WebControls.DataGrid.EditCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataGrid.OnEditCommand(System.Web.UI.WebControls.DataGridCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataGrid.EditCommand event. A System.Web.UI.WebControls.DataGridCommandEventArgs that contains event data.
OnItemCommand
Raises the System.Web.UI.WebControls.DataGrid.ItemCommand event. This allows you to provide a custom handler for the event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataGrid.OnItemCommand(System.Web.UI.WebControls.DataGridCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataGrid.ItemCommand event. A System.Web.UI.WebControls.DataGridCommandEventArgs that contains event data.
OnItemCreated
Raises the System.Web.UI.WebControls.DataGrid.ItemCreated event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataGrid.ItemCreated(System.Web.UI.WebControls.DataGridItemEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataGrid.ItemCreated event. A System.Web.UI.WebControls.DataGridItemEventArgs that contains event data.
OnItemDataBound
Raises the System.Web.UI.WebControls.DataGrid.ItemDataBound event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataGrid.ItemDataBound(System.Web.UI.WebControls.DataGridItemEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataGrid.ItemDataBound event. A System.Web.UI.WebControls.DataGridItemEventArgs that contains event data.
OnPageIndexChanged
Raises the System.Web.UI.WebControls.DataGrid.PageIndexChanged event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataGrid.OnPageIndexChanged(System.Web.UI.WebControls.DataGridPageChangedEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataGrid.PageIndexChanged event. A System.Web.UI.WebControls.DataGridPageChangedEventArgs that contains event data.
OnSortCommand
Raises the System.Web.UI.WebControls.DataGrid.SortCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataGrid.OnSortCommand(System.Web.UI.WebControls.DataGridSortCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataGrid.SortCommand event. A System.Web.UI.WebControls.DataGridSortCommandEventArgs that contains event data.
OnUpdateCommand
Raises the System.Web.UI.WebControls.DataGrid.UpdateCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataGrid.OnUpdateCommand(System.Web.UI.WebControls.DataGridCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataGrid.UpdateCommand event. A System.Web.UI.WebControls.DataGridCommandEventArgs that contains event data.
PrepareControlHierarchy
SaveViewState
Saves the current state of the System.Web.UI.WebControls.DataGrid.
Return Value: The saved state of the System.Web.UI.WebControls.DataGrid.
TrackViewState
Marks the starting point to begin tracking and saving changes to the control as part of the control viewstate.
DataGridColumn class (System.Web.UI.WebControls)
TrackViewState
Description
Serves as the base class for the different column types of the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.DataGridColumn class is the base class for all column types of the System.Web.UI.WebControls.DataGrid control. It defines the properties and methods that are common to all column types. An instance of the System.Web.UI.WebControls.DataGridColumn class is typically not created directly.
DataGridColumn
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.DataGridColumn class.
Use this constructor to create and initialize an instance of the System.Web.UI.WebControls.DataGridColumn class.
DesignMode
TrackViewState
Gets a value that indicates whether the column is in design mode.
Use the System.Web.UI.WebControls.DataGridColumn.DesignMode property to programmatically determine whether the column is in design mode
FooterStyle
TrackViewState
Gets the style properties for the tooter section of the column.
Use this property to provide a custom style for the tooter section of the column. Common style attributes that can be adjusted, include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the column in the System.Web.UI.WebControls.DataGrid control.
FooterText
TrackViewState
Gets or sets the text displayed in the tooter section of the column.
Use the System.Web.UI.WebControls.DataGridColumn.FooterText property to specify or determine the text displayed in the tooter section of the column.
HeaderImageUrl
TrackViewState
Gets or sets the location of an image to display in the header section of the column.
Use the System.Web.UI.WebControls.DataGridColumn.HeaderImageUrl property to specify the URL of an image to display in the header section of the column. You can use a relative or an absolute URL. A relative URL relates the location of the image to the location of the Web page without specifying a complete path on the server. The path is relative to the location of the Web page. This makes it easier to move the entire site to another directory on the server without updating the path to the image in code. An absolute URL provides the complete path, so moving the site to another directory requires updating the code.
HeaderStyle
TrackViewState
Gets the style properties for the header section of the column.
Use this property to provide a custom style for the header section of the column. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the column in the System.Web.UI.WebControls.DataGrid control.
HeaderText
TrackViewState
Gets or sets the text displayed in the header section of the column.
Use the System.Web.UI.WebControls.DataGridColumn.HeaderText property to specify or determine the text displayed in the tooter section of the column.
IsTrackingViewState
TrackViewState
Determines if the System.Web.UI.WebControls.DataGridColumn is marked to save its state.
ItemStyle
TrackViewState
Gets the style properties for the item cells of the column.
Use this property to provide a custom style for the item cells of the column. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the column in the System.Web.UI.WebControls.DataGrid control.
Owner
TrackViewState
Gets the System.Web.UI.WebControls.DataGrid control that the column is a member of.
Use the System.Web.UI.WebControls.DataGridColumn.Owner property to programmatically determine the System.Web.UI.WebControls.DataGrid control that the column is a member of.
SortExpression
TrackViewState
Gets or sets the name of the field to pass to the System.Web.UI.WebControls.DataGrid.OnSortCommand(System.Web.UI.WebControls.DataGridSortCommandEventArgs) method when a column is selected for sorting.
Use the System.Web.UI.WebControls.DataGridColumn.SortExpression property to specify or determine the name of the field to pass to the System.Web.UI.WebControls.DataGrid.OnSortCommand(System.Web.UI.WebControls.DataGridSortCommandEventArgs) method when a column is selected for sorting.
ViewState
TrackViewState
Gets the statebag for the System.Web.UI.WebControls.DataGridColumn. This property is read-only.
Visible
TrackViewState
Gets or sets a value that indicates whether the column is visible in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGridColumn.Visible property to programmatically control whether the column is visible in the System.Web.UI.WebControls.DataGrid control.
Initialize
InitializeCell
Initializes a cell in the System.Web.UI.WebControls.DataGridColumn. A System.Web.UI.WebControls.TableCell that contains information about the cell. The column number of the cell to initialize. One of the System.Web.UI.WebControls.ListItemType values.
LoadViewState
Loads the state of the System.Web.UI.WebControls.DataGridColumn. An System.Object that contains the saved state of the System.Web.UI.WebControls.DataGridColumn.
OnColumnChanged
Raises the ColumnChanged event of a System.Web.UI.WebControls.DataGridColumn object.
SaveViewState
Saves the current state of the System.Web.UI.WebControls.DataGridColumn. Return Value: An System.Object that contains the saved state of the System.Web.UI.WebControls.DataGridColumn.
IStateManager.LoadViewState
IStateManager.SaveViewState
IStateManager.TrackViewState
ToString
Returns the string representation of the column.
Return Value: Returns System.String.Empty.
Use the System.Web.UI.WebControls.DataGridColumn.ToString method to get the string representation of the column.
TrackViewState
Marks the starting point to begin tracking and saving changes to the control as part of the control viewstate.
DataGridColumnCollection class (System.Web.UI.WebControls)
TrackViewState
Description
A collection of System.Web.UI.WebControls.DataGridColumn derived column objects that represent the columns in a System.Web.UI.WebControls.DataGrid control. This class cannot be inherited.
Use the System.Web.UI.WebControls.DataGridColumnCollection to programmatically manage a collection of System.Web.UI.WebControls.DataGridColumn derived column objects. These objects represent the columns in a System.Web.UI.WebControls.DataGrid control. You can add, remove, or insert columns into the System.Web.UI.WebControls.DataGridColumnCollection.
DataGridColumnCollection
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.DataGridColumnCollection class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataGridColumnCollection class. The System.Web.UI.WebControls.DataGrid control that corresponds with this collection. A System.Collections.ArrayList object that stores the collection of columns.
Count
TrackViewState
Gets the number of columns in the System.Web.UI.WebControls.DataGridColumnCollection.
Use this property to determine the number of columns in the System.Web.UI.WebControls.DataGridColumnCollection. The System.Web.UI.WebControls.DataGridColumnCollection.Count property is commonly used when iterating through the collection to determine the upper bound of the collection.
IsReadOnly
TrackViewState
Gets a value that indicates whether the columns in the System.Web.UI.WebControls.DataGridColumnCollection can be modified.
This property always returns false to indicate that the System.Web.UI.WebControls.DataGridColumnCollection can be written to in all cases.
IsSynchronized
TrackViewState
Gets a value indicating whether access to the System.Web.UI.WebControls.DataGridColumnCollection is synchronized (thread-safe).
This property is derived from the System.Collections.ICollection class and overridden to always return false.
Item
TrackViewState
Gets a System.Web.UI.WebControls.DataGridColumn derived column object from the System.Web.UI.WebControls.DataGridColumnCollection collection at the specified index.
Use this indexer to get a System.Web.UI.WebControls.DataGridColumn derived column object from the System.Web.UI.WebControls.DataGridColumnCollection at the specified index using array notation. The index of the System.Web.UI.WebControls.DataGridColumn derived object in the System.Web.UI.WebControls.DataGridColumnCollection collection to retrieve.
SyncRoot
TrackViewState
Gets the object that can be used to synchronize access to the System.Web.UI.WebControls.DataGridColumnCollection.
The object returned in this implementation is the System.Web.UI.WebControls.DataGridColumnCollection object.
Add
Appends the specified System.Web.UI.WebControls.DataGridColumn derived column object to the end of the System.Web.UI.WebControls.DataGridColumnCollection.
Use this method to add a System.Web.UI.WebControls.DataGridColumn derived column object to the end of a System.Web.UI.WebControls.DataGridColumnCollection. The System.Web.UI.WebControls.DataGridColumn derived column object to append to the System.Web.UI.WebControls.DataGridColumnCollection.
AddAt
Inserts a System.Web.UI.WebControls.DataGridColumn derived column object in the System.Web.UI.WebControls.DataGridColumnCollection at the specified index.
Use this method to insert a System.Web.UI.WebControls.DataGridColumn derived column object at the specified index location in the System.Web.UI.WebControls.DataGridColumnCollection. The index location in the System.Web.UI.WebControls.DataGridColumnCollection to insert the System.Web.UI.WebControls.DataGridColumn derived column object. The System.Web.UI.WebControls.DataGridColumn derived column object to insert into the System.Web.UI.WebControls.DataGridColumnCollection.
Clear
Removes all System.Web.UI.WebControls.DataGridColumn derived column objects from the System.Web.UI.WebControls.DataGridColumnCollection.
Use this method to remove all System.Web.UI.WebControls.DataGridColumn derived column objects from the System.Web.UI.WebControls.DataGridColumnCollection.
CopyTo
Copies the items from the System.Web.UI.WebControls.DataGridColumnCollection to the specified System.Array object, starting at the specified index in the System.Array object.
Use this method to copy the contents of the System.Web.UI.WebControls.DataGridColumnCollection into the specified System.Array object, starting at the specified index. A zero-based System.Array object that receives the copied items from the System.Web.UI.WebControls.DataGridColumnCollection. The first position in the specified System.Array object to receive the copied contents.
GetEnumerator
Returns an System.Collections.IEnumerator interface that contains all System.Web.UI.WebControls.DataGridColumn derived column objects in the System.Web.UI.WebControls.DataGridColumnCollection.
Return Value: A System.Collections.IEnumerator interface that contains all System.Web.UI.WebControls.DataGridColumn derived column objects in the System.Web.UI.WebControls.DataGridColumnCollection.
Use this method to create a System.Collections.IEnumerator that can be iterated through easily to get each item in the System.Web.UI.WebControls.DataGridColumnCollection.
IndexOf
Returns the index of the specified System.Web.UI.WebControls.DataGridColumn derived column object from the System.Web.UI.WebControls.DataGridColumnCollection.
Return Value: The index position of the specified System.Web.UI.WebControls.DataGridColumn derived column object in the System.Web.UI.WebControls.DataGridColumnCollection. The default value is −1, which indicates that the specified System.Web.UI.WebControls.DataGridColumn derived object is not found.
Use this method to determine the index number of the specified System.Web.UI.WebControls.DataGridColumn derived column object in the System.Web.UI.WebControls.DataGridColumnCollection. If the specified System.Web.UI.WebControls.DataGridColumn derived column object is not found, an index of −1 is returned. The System.Web.UI.WebControls.DataGridColumn derived column object to search for in the System.Web.UI.WebControls.DataGridColumnCollection.
Remove
Removes the specified System.Web.UI.WebControls.DataGridColumn derived column object from the System.Web.UI.WebControls.DataGridColumnCollection.
Use this method to remove the specified System.Web.UI.WebControls.DataGridColumn derived column object from a System.Web.UI.WebControls.DataGridColumnCollection. The System.Web.UI.WebControls.DataGridColumn derived column object to remove from the System.Web.UI.WebControls.DataGridColumnCollection.
RemoveAt
Removes a System.Web.UI.WebControls.DataGridColumn derived column object from the System.Web.UI.WebControls.DataGridColumnCollection at the specified index.
Use this method to remove a System.Web.UI.WebControls.DataGridColumn derived column object from a System.Web.UI.WebControls.DataGridColumnCollection at the specified index. The index of the System.Web.UI.WebControls.DataGridColumn derived column object in the System.Web.UI.WebControls.DataGridColumnCollection to remove.
IStateManager.LoadViewState
IStateManager. SaveViewState
IStateManager.TrackViewState
DataGridCommandEventArgs class (System.Web.UI.WebControls)
ToString
Description
Provides data for the System.Web.UI.WebControls.DataGrid.CancelCommand, System.Web.UI.WebControls.DataGrid.DeleteCommand, System.Web.UI.WebControls.DataGrid.EditCommand, System.Web.UI.WebControls.DataGrid.ItemCommand, and System.Web.UI.WebControls.DataGrid.UpdateCommand events of the System.Web.UI.WebControls.DataGrid control. This class cannot be inherited.
The System.Web.UI.WebControls.DataGrid.CancelCommand event is raised when the Cancel button for an item in the System.Web.UI.WebControls.DataGrid control is clicked.
DataGridCommandEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.DataGridCommandEventArgs class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataGridCommandEventArgs class. A System.Web.UI.WebControls.DataGridItem that represents the selected item in the System.Web.UI.WebControls.DataGrid. The source of the command. A System.Web.UI.WebControls.CommandEventArgs that contains the event data.
CommandArgument
CommandName
CommandSource
ToString
Description
Gets the source of the command.
Use the System.Web.UI.WebControls.DataGridCommandEventArgs.CommandSource property to determine the command source that raised the event. This property is commonly used to determine which command raised the event.
Item
ToString
Gets the item containing the command source in the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.DataGridCommandEventArgs.Item property is used to access the properties of the selected item in the System.Web.UI.WebControls.DataGrid control.
DataGridCommandEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.DataGrid.CancelCommand, System.Web.UI.WebControls.DataGrid.DeleteCommand, System.Web.UI.WebControls.DataGrid.EditCommand, System.Web.UI.WebControls.DataGrid.ItemCommand, and System.Web.UI.WebControls.DataGrid.UpdateCommand events of a System.Web.UI.WebControls.DataGrid. The source of the event. A System.Web.UI.WebControls.DataGridCommandEventArgs that contains the event data.
When you create a System.Web.UI.WebControls.DataGridCommandEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see.
DataGridItem class (System.Web.UI.WebControls)
ToString
Description
Represents an item (row) in the System.Web.UI.WebControls.DataGrid control.
A System.Web.UI.WebControls.DataGridItem object represents an item (row) in the System.Web.UI.WebControls.DataGrid control, such as the heading section, the tooter section, or a data row.
DataGridItem
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.DataGridItem class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataGridItem class. The index of the item in the System.Web.UI.WebControls.DataGrid control from the System.Web.UI.WebControls.DataGrid.Items collection. The index number of the item, from the bound data source, that appears in the System.Web.UI.WebControls.DataGrid control. One of the System.Web.UI.WebControls.ListItemType values.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
Cells
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DataItem
ToString
Description
Gets or sets the data item represented by the System.Web.UI.WebControls.DataGridItem object in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGridItem property to specify or determine the properties of a data item represented by the System.Web.UI.WebControls.DataGridItem object in the System.Web.UI.WebControls.DataGrid control.
DataSetIndex
ToString
Gets the index number the System.Web.UI.WebControls.DataGridItem object from the bound data source.
Use the System.Web.UI.WebControls.DataGridItem.DataSetIndex property to the index number of the System.Web.UI.WebControls.DataGridItem object from the bound data source.
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
HorizontalAlign
ID
IsTrackingViewState
ItemIndex
ToString
Description
Gets the index of the System.Web.UI.WebControls.DataGridItem object from the System.Web.UI.WebControls.DataGrid.Items collection of the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGridItem.ItemIndex property to determine the index number of the System.Web.UI.WebControls.DataGridItem object from the System.Web.UI.WebControls.DataGrid.Items collection of the System.Web.UI.WebControls.DataGrid control.
ItemType
ToString
Gets the type of the item represented by the System.Web.UI.WebControls.DataGridItem object in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGridItem.ItemType property to determine the type of an item in the System.Web.UI.WebControls.DataGrid control. The following table lists the various item types.
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
VerticalAlign
ViewState
ViewStateIgnoresCase
Visible
Width
OnBubbleEvent
SetItemType
DataGridItemCollection class (System.Web.UI.WebControls)
TrackViewState
Description
Represents a collection of System.Web.UI.WebControls.DataGridItem objects in a System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.DataGridItemCollection class represents a collection of System.Web.UI.WebControls.DataGridItem objects, which in turn represent the data items in a System.Web.UI.WebControls.DataGrid control. To programmatically retrieve System.Web.UI.WebControls.DataGridItem objects from a System.Web.UI.WebControls.DataGrid control, use one of following methods: Use the indexer to get a single System.Web.UI.WebControls.DataGridItem object from the collection, using array notation.
DataGridItemCollection
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.DataGridItemCollection class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataGridItemCollection class. A System.Collections.ArrayList object that contains the items with which to initialize the collection.
Count
TrackViewState
Gets the number of System.Web.UI.WebControls.DataGridItem objects in the collection.
Use the System.Web.UI.WebControls.DataGridItemCollection.Count property to determine the number of System.Web.UI.WebControls.DataGridItem objects in the System.Web.UI.WebControls.DataGridItemCollection collection. The System.Web.UI.WebControls.DataGridItemCollection.Count property is commonly used when iterating through the collection to determine the upper bound of the collection.
IsReadOnly
TrackViewState
Gets a value that indicates whether the System.Web.UI.WebControls.DataGridItem objects in the System.Web.UI.WebControls.DataGridItemCollection can be modified.
This property always returns false to indicate that the System.Web.UI.WebControls.DataGridItemCollection can be written to in all cases.
IsSynchronized
TrackViewState
Gets a value indicating whether access to the System.Web.UI.WebControls.DataGridItemCollection is synchronized (thread-safe).
This property is derived from the System.Collections.ICollection class and is overridden to always return false.
Item
TrackViewState
Gets the System.Web.UI.WebControls.DataGridItem object at the specified index in the collection.
Use this indexer to get a System.Web.UI.WebControls.DataGridItem object from the System.Web.UI.WebControls.DataGridItemCollection at the specified index, using array notation. The zero-based index of the System.Web.UI.WebControls.DataGridItem object to retrieve from the collection.
SyncRoot
TrackViewState
Gets the object that can be used to synchronize access to the System.Web.UI.WebControls.DataGridItemCollection.
The object returned in this implementation is the System.Web.UI.WebControls.DataGridItemCollection object itself.
CopyTo
Copies all the items from this System.Web.UI.WebControls.DataGridItemCollection to the specified System.Array object, starting at the specified index in the System.Array object.
Use this method to copy the contents of the System.Web.UI.WebControls.DataGridItemCollection collection into the specified System.Array object, starting at the specified index. A zero-based System.Array object that receives the copied items from the System.Web.UI.WebControls.DataGridItemCollection. The first position in the specified System.Array object to receive the copied contents.
GetEnumerator
Returns a System.Collections.IEnumerator interface that contains all System.Web.UI.WebControls.DataGridItem objects in the System.Web.UI.WebControls.DataGridItemCollection.
Return Value: A System.Collections.IEnumerator interface that contains all System.Web.UI.WebControls.DataGridItem objects in the System.Web.UI.WebControls.DataGridItemCollection.
Use this method to create a System.Collections.IEnumerator that can be easily iterated through to get each item in the System.Web.UI.WebControls.DataGridItemCollection.
DataGridItemEventArgs class (System.Web.UI.WebControls)
ToString
Description
Provides data for the System.Web.UI.WebControls.DataGrid.ItemCreated and System.Web.UI.WebControls.DataGrid.ItemDataBound events of the System.Web.UI.WebControls.DataGrid control. This class cannot be inherited.
The System.Web.UI.WebControls.DataGrid.ItemCreated event is raised when an item in the System.Web.UI.WebControls.DataGrid control is created.
DataGridItemEventArgs
Example Syntax:
ToString
Initializes a new instance of System.Web.UI.WebControls.DataGridItemEventArgs class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataGridItemEventArgs class. A System.Web.UI.WebControls.DataGridItem that represents an item in the System.Web.UI.WebControls.DataGrid.
Item
ToString
Gets the referenced item in the System.Web.UI.WebControls.DataGrid control when the event is raised.
Use this property to programmatically access the item referenced in the System.Web.UI.WebControls.DataGrid control when the event is raised.
DataGridItemEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.DataGrid.ItemCreated and System.Web.UI.WebControls.DataGrid.ItemDataBound events of a System.Web.UI.WebControls.DataGrid. The source of the event. A System.Web.UI.WebControls.DataGridItemEventArgs than contains the event data.
The System.Web.UI.WebControls.DataGrid.ItemCreated event is raised when an item in the System.Web.UI.WebControls.DataGrid control is created.
DataGridPageChangedEventArgs class (System.Web.UI.WebControls)
ToString
Description
Provides data for the System.Web.UI.WebControls.DataGrid.PageIndexChanged event of the System.Web.UI.WebControls.DataGrid control. This class cannot be inherited.
The System.Web.UI.WebControls.DataGrid.PageIndexChanged event is raised when a button in the page selection element of the System.Web.UI.WebControls.DataGrid control is clicked.
DataGridPageChangedEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.DataGridPageChangedEventArgs class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataGridPageChangedEventArgs class. The source of the command. The index of the page selected by the user from the page selection element of the System.Web.UI.WebControls.DataGrid control.
CommandSource
ToString
Gets the source of the command.
Use the System.Web.UI.WebControls.DataGridPageChangedEventArgs.CommandSource property to determine the source of the command that raised the event. Because this event is only raised when a button in the page selection element of the System.Web.UI.WebControls.DataGrid control is clicked, the returned source is a System.Web.UI.WebControls.DataGridItem that represents the page selection element.
NewPageIndex
ToString
Gets the index of the page selected by the user in the page selection element of the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGridPageChangedEventArgs.NewPageIndex property to determine the index of the page selected by the user in the page selection element of the System.Web.UI.WebControls.DataGrid control. This value is often used to set the System.Web.UI.WebControls.DataGrid.CurrentPageIndex property of the System.Web.UI.WebControls.DataGrid control to display the selected page.
DataGridPageChangedEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.DataGrid.PageIndexChanged event of the System.Web.UI.WebControls.DataGrid control. The source of the event. A System.Web.UI.WebControls.DataGridPageChangedEventArgs that contains the event data.
The System.Web.UI.WebControls.DataGrid.PageIndexChanged event is raised when a button in the page selection element of the System.Web.UI.WebControls.DataGrid control is clicked.
DataGridPagerStyle class (System.Web.UI.WebControls)
ToString
Description
Specifies the style for the pager of the System.Web.UI.WebControls.DataGrid control. This class cannot be inherited.
The pager is an element on the System.Web.UI.WebControls.DataGrid control that allow you to link to other pages when paging is enabled. The System.Web.UI.WebControls.DataGrid.PagerStyle property of the System.Web.UI.WebControls.DataGrid uses an instance of this class to represent the style properties for the pager.
BackColor
BorderColor
BorderStyle
BorderWidth
Container
CssClass
DesignMode
Events
Font
ForeColor
Height
HorizontalAlign
IsEmpty
IsTrackingViewState
Mode
ToString
Description
Gets or sets a value that specifies whether the pager element displays buttons that link to the next and previous page, or numeric buttons that link directly to a page.
Use the System.Web.UI.WebControls.DataGridPagerStyle.Mode property to specify which set of pager buttons to use on the System.Web.UI.WebControls.DataGrid control. You can specify buttons that link to the next and previous page, or numeric buttons that link directly to a page.
NextPageText
ToString
Gets or sets the text displayed for the next page button.
Use the System.Web.UI.WebControls.DataGridPagerStyle.NextPageText property to provide custom text for the next page button. The System.Web.UI.WebControls.DataGridPagerStyle.Mode property must be set to PagerMode.NextPrev for this property to have any effect.
PageButtonCount
ToString
Gets or sets the number of numeric buttons to display concurrently in the pager element of the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGridPagerStyle.PageButtonCount property to specify the number of numeric buttons to display concurrently in the pager element of the System.Web.UI.WebControls.DataGrid control. The System.Web.UI.WebControls.DataGridPagerStyle.Mode property must be set to PagerMode.NumericPages for this property to have any effect.
Position
ToString
Gets or sets the position of the pager element in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGridPagerStyle.Position property to specify the location where the pager element is displayed in the System.Web.UI.WebControls.DataGrid control. The pager element can be displayed at the upper edge, the lower edge, or at both the upper and lower edges of the System.Web.UI.WebControls.DataGrid control.
PrevPageText
ToString
Gets or sets the text displayed for the previous page button.
Use the System.Web.UI.WebControls.DataGridPagerStyle.PrevPageText property to provide custom text for the next page button. The System.Web.UI.WebControls.DataGridPagerStyle.Mode property must be set to PagerMode.NextPrev for this property to have any effect.
Site
VerticalAlign
ViewState
Visible
ToString
Description
Gets or sets a value indicating whether the pager is displayed in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGridPagerStyle.Visible property to specify whether the pager is displayed in the System.Web.UI.WebControls.DataGrid control.
Width
Wrap
CopyFrom
Copies the style of the specified System.Web.UI.WebControls.Style object into this instance of the System.Web.UI.WebControls.DataGridPagerStyle class.
Use the System.Web.UI.WebControls.DataGridPagerStyle.CopyFrom(System.Web.UI.WebControls.Style) method to copy the style properties of the specified System.Web.UI.WebControls.Style object into this instance of the System.Web.UI.WebControls.DataGridPagerStyle class. The System.Web.UI.WebControls.Style object to copy from.
MergeWith
Merges the style of the specified System.Web.UI.WebControls.Style object with this instance of the System.Web.UI.WebControls.DataGridPagerStyle class.
Use the System.Web.UI.WebControls.DataGridPagerStyle.MergeWith(System.Web.UI.WebControls.Style) method to combine the style properties of the specified System.Web.UI.WebControls.Style object with this instance of the System.Web.UI.WebControls.DataGridPagerStyle class. If a property from this instance is already set to a value, the property is unchanged. If a property is not set, this method sets that property with the value from the corresponding property the System.Web.UI.WebControls.Style object. The System.Web.UI.WebControls.Style object to merge with.
Reset
Restores the System.Web.UI.WebControls.DataGridPagerStyle object to its default values.
Use the System.Web.UI.WebControls.DataGridPagerStyle.Reset method to restore the System.Web.UI.WebControls.DataGridPagerStyle object to its default values.
DataGridSortCommandEventArgs class (System.Web.UI.WebControls)
TrackViewState
Description
Provides data for the System.Web.UI.WebControls.DataGrid.SortCommand event of the System.Web.UI.WebControls.DataGrid control. This class cannot be inherited.
When sorting is enabled by setting the System.Web.UI.WebControls.DataGrid.AllowSorting property of the System.Web.UI.WebControls.DataGrid control to true, System.Web.UI.WebControls.LinkButton controls are rendered in the header of each column that has the System.Web.UI.WebControls.DataGridColumn.SortExpression property set. (For automatically generated columns, the System.Web.UI.WebControls.DataGridColumn.SortExpression property contains the same value as the data field.) These links allow you to sort the System.Web.UI.WebControls.DataGrid control by the selected column. The System.Web.UI.WebControls.DataGrid.SortCommand event is raised when a System.Web.UI.WebControls.LinkButton control is clicked.
DataGridSortCommandEventArgs
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.DataGridSortCommandEventArgs class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataGridSortCommandEventArgs class. The source of the command. A System.Web.UI.WebControls.DataGridCommandEventArgs that contains the event data.
CommandSource
TrackViewState
Gets the source of the command.
Use the System.Web.UI.WebControls.DataGridSortCommandEventArgs.CommandSource property to get the command source that raises the System.Web.UI.WebControls.DataGrid.SortCommand event. Because this event is only raised when a link is clicked in the header of the System.Web.UI.WebControls.DataGrid control, the returned source is a System.Web.UI.WebControls.DataGridItem that represents the header. This property can be used to programmatically control the header.
SortExpression
TrackViewState
Gets the expression used to sort the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataGridSortCommandEventArgs.SortExpression property to determine which column the user selects to sort the System.Web.UI.WebControls.DataGrid control.
DataGridSortCommandEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.DataGrid.SortCommand event of the System.Web.UI.WebControls.DataGrid control. The source of the event. A System.Web.UI.WebControls.DataGridSortCommandEventArgs that contains the event data.
When sorting is enabled by setting the System.Web.UI.WebControls.DataGrid.AllowSorting property of the System.Web.UI.WebControls.DataGrid control to true, System.Web.UI.WebControls.LinkButton controls are rendered in the header of each column. These links allow you to sort the System.Web.UI.WebControls.DataGrid control by the selected column. The System.Web.UI.WebControls.DataGrid.SortCommand event is raised when a System.Web.UI.WebControls.LinkButton control is clicked.
DataKeyCollection class (System.Web.UI.WebControls)
ToString
Description
Represents a collection of primary key field names. This class cannot be inherited.
DataKeyCollection
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.DataKeyCollection class. A System.Collections.ArrayList to store the keys.
Count
ToString
Gets the number of objects in the collection. This property is read-only.
IsReadOnly
ToString
Gets the value that specifies whether items in the System.Web.UI.WebControls.DataKeyCollection can be modified. This property is read-only.
IsSynchronized
ToString
Gets a value that indicates whether the System.Web.UI.WebControls.DataKeyCollection is thread-safe. This property is read-only.
Item
ToString
Gets the primary key field name at the specified index in the collection. This property is read-only. The index of the primary key field name in the collection to retrieve.
SyncRoot
ToString
Gets the object used to synchronize access to the collection. This property is read-only.
CopyTo
Copies the contents of the entire collection into an System.Array appending at the specified index of the System.Array. The System.Array to copy the contents of the collection into. The index of the System.Array to begin copying the contents of the collection into.
GetEnumerator
Creates an enumerator for the System.Web.UI.WebControls.DataKeyCollection used to iterate through the collection.
DataList class (System.Web.UI.WebControls)
ToString
Description
A data bound list control that displays items using templates.
Use the System.Web.UI.WebControls.DataList control to display a template-defined data bound list. The System.Web.UI.WebControls.DataList control supports selecting and editing.
ToString
Represents the Cancel command name. This field is read-only.
Use the System.Web.UI.WebControls.DataList.CancelCommandName field to represent the Cancel command name.
ToString
Represents the Delete command name. This field is read-only.
Use the System.Web.UI.WebControls.DataList.DeleteCommandName field to represent the Delete command name.
ToString
Represents the Edit command name. This field is read-only.
Use the System.Web.UI.WebControls.DataList.EditCommandName field to represent the Edit command name.
ToString
Represents the Select command name. This field is read-only. Use the System.Web.UI.WebControls.DataList.SelectCommandName field to represent the Select command name.
ToString
Represents the Update command name. This field is read-only.
Use the System.Web.UI.WebControls.DataList.UpdateCommandName field to represent the Update command name.
DataList
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.DataList class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataList class.
AccessKey
AlternatingItemStyle
ToString
Description
Gets the style properties for alternating items in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.AlternatingItemStyle property to provide a custom style for the alternating items in the System.Web.UI.WebControls.DataList control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataList control.
AlternatingItemTemplate
ToString
Gets or sets the template for alternating items in the System.Web.UI.WebControls.DataList.
Use the System.Web.UI.WebControls.DataList.AlternatingItemTemplate property to control the contents of alternating items in the System.Web.UI.WebControls.DataList control. The appearance of alternating items is controlled by the System.Web.UI.WebControls.DataList.AlternatingItemStyle property.
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
CellPadding
CellSpacing
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DataKeyField
DataKeys
DataKeysArray
DataMember
DataSource
EditItemIndex
ToString
Description
Gets or sets the index number of the selected item in the System.Web.UI.WebControls.DataList control to edit.
Use the System.Web.UI.WebControls.DataList.EditItemIndex property to programmatically specify the item selected for editing. You can also use this property to determine the index of the item selected for editing.
EditItemStyle
ToString
Gets the style properties for the item selected for editing in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.EditItemStyle property to provide a custom style for the item selected for editing in the System.Web.UI.WebControls.DataList control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataList control.
EditItemTemplate
ToString
Gets or sets the template for the item selected for editing in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.EditItemTemplate property to control the contents of the item selected for editing in the System.Web.UI.WebControls.DataList control. The appearance of the item selected for editing is controlled by the System.Web.UI.WebControls.DataList.EditItemStyle property.
Enabled
EnableViewState
Events
ExtractTemplateRows
ToString
Description
Gets or sets a value that indicates whether the rows of a System.Web.UI.WebControls.Table control, defined in each template of a System.Web.UI.WebControls.DataList control, are extracted and displayed.
The contents of the System.Web.UI.WebControls.DataList control are specified by using templates. Normally, you list controls that you want to display in the templates. You can also place a System.Web.UI.WebControls.Table control in a template and display the rows of the table.
Font
FooterStyle
ToString
Description
Gets the style properties for the tooter section of the System.Web.UI.WebControls.DataList control.
Use this property to provide a custom style for the tooter section of the System.Web.UI.WebControls.DataList control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataList control.
FooterTemplate
ToString
Gets or sets the template for the tooter section of the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.FooterTemplate property to control the contents of the tooter section. The appearance of the tooter section is controlled by the System.Web.UI.WebControls.DataList.FooterStyle property.
ForeColor
GridLines
ToString
Description
Gets or sets the grid line style for the System.Web.UI.WebControls.DataList control when the System.Web.UI.WebControls.DataList.RepeatLayout property is set to RepeatLayout.Table.
Use the System.Web.UI.WebControls.DataList.GridLines property to specify the grid line style for the System.Web.UI.WebControls.DataList control. The following table lists the possible styles.
HasChildViewState
HeaderStyle
ToString
Description
Gets the style properties for the heading section of the System.Web.UI.WebControls.DataList control.
Use this property to provide a custom style for the heading of the System.Web.UI.WebControls.DataList control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataList control.
HeaderTemplate
ToString
Gets or sets the template for the heading section of the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.HeaderTemplate property to control the contents of the heading section. The appearance of the header section is controlled by the System.Web.UI.WebControls.DataList.HeaderStyle property.
Height
HorizontalAlign
ID
IsTrackingViewState
Items
ToString
Description
Gets a collection of System.Web.UI.WebControls.DataListItem objects representing the individual items within the control.
Use the System.Web.UI.WebControls.DataList.Items collection to programmatically control the items in the System.Web.UI.WebControls.DataList control. The System.Web.UI.WebControls.DataList.Items collection does not provide any methods to add or remove items to the collection. However, you can control the contents of an item by providing a handler for the System.Web.UI.WebControls.DataList.ItemCreated event.
ItemStyle
ToString
Gets the style properties for the items in the System.Web.UI.WebControls.DataList control.
Use this property to provide a custom style for the items of the System.Web.UI.WebControls.DataList control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataList control.
ItemTemplate
ToString
Gets or sets the template for the items in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.ItemTemplate property to control the contents of the items in the System.Web.UI.WebControls.DataList control. The appearance of the items in the System.Web.UI.WebControls.DataList control is controlled by the System.Web.UI.WebControls.DataList.ItemStyle property.
NamingContainer
Page
Parent
RepeatColumns
ToString
Description
Gets or sets the number of columns to display in the System.Web.UI.WebControls.DataList control.
Use this property to specify the number of columns that display items in the System.Web.UI.WebControls.DataList control. For example, if you set this property to 5, the System.Web.UI.WebControls.DataList control displays its items in five columns.
RepeatDirection
ToString
Gets or sets whether the System.Web.UI.WebControls.DataList control displays vertically or horizontally.
Use the System.Web.UI.WebControls.DataList.RepeatDirection property to specify the display direction of the System.Web.UI.WebControls.DataList control.
RepeatLayout
ToString
Gets or sets whether the control is displayed in a table or flow layout.
Use the System.Web.UI.WebControls.DataList.RepeatLayout property to specify whether the items in the System.Web.UI.WebControls.DataList control are displayed in a table. If this property is set to RepeatLayout.Table, the items in the list are displayed in a table. If this property is set to RepeatLayout.Flow, the items in the list are displayed without a table structure.
SelectedIndex
ToString
Gets or sets the index of the selected item in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.SelectedIndex property to programmatically specify the selected item in the System.Web.UI.WebControls.DataList control. You can also use this property to determine the index of the selected item.
SelectedItem
ToString
Gets the selected item in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.SelectedItem property to get a System.Web.UI.WebControls.DataListItem object that represents the selected item in the System.Web.UI.WebControls.DataList control. This object can then be used to access the properties of the selected item.
SelectedItemStyle
ToString
Gets the style properties for the selected item in the System.Web.UI.WebControls.DataList control.
Use this property to provide a custom style for the selected item in the System.Web.UI.WebControls.DataList control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataList control.
SelectedItemTemplate
ToString
Gets or sets the template for the selected item in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.SelectedItemTemplate property to control the contents of the selected item. The appearance of the selected item is controlled by the System.Web.UI.WebControls.DataList.SelectedItemStyle property.
SeparatorStyle
ToString
Gets the style properties of the separator between each item in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.SeparatorStyle property to provide a custom style for the separator between each item in the System.Web.UI.WebControls.DataList control. The separator allows you to place an element with custom content between each item in the System.Web.UI.WebControls.DataList control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the System.Web.UI.WebControls.DataList control.
SeparatorTemplate
ToString
Gets or sets the template for the separator between the items of the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.SeparatorTemplate property to control the contents of the separator between the items of the System.Web.UI.WebControls.DataList control. The separator allows you to place an element with custom content between each item in the System.Web.UI.WebControls.DataList control. The appearance of the separator between the items of the System.Web.UI.WebControls.DataList control is controlled by the System.Web.UI.WebControls.DataList.SeparatorStyle property.
ShowFooter
ToString
Gets or sets a value indicating whether the tooter section is displayed in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.ShowFooter property to specify whether the tooter section is displayed in the System.Web.UI.WebControls.DataList control.
ShowHeader
ToString
Gets or sets a value indicating whether the header section is displayed in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataList.ShowHeader property to specify whether the header section is displayed in the System.Web.UI.WebControls.DataList control.
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
ToString
Description
Occurs when the Cancel button is clicked for an item in the System.Web.UI.WebControls.DataList control.
The System.Web.UI.WebControls.DataList.CancelCommand event is raised when the Cancel button is clicked for an item in the System.Web.UI.WebControls.DataList control.
ToString
Description
Occurs when the Delete button is clicked for an item in the System.Web.UI.WebControls.DataList control.
The System.Web.UI.WebControls.DataList.DeleteCommand event is raised when the Delete button is clicked for an item in the System.Web.UI.WebControls.DataList control.
ToString
Description
Occurs when the Edit button is clicked for an item in the System.Web.UI.WebControls.DataList control.
The System.Web.UI.WebControls.DataList.EditCommand event is raised when the Edit button is clicked for an item in the System.Web.UI.WebControls.DataList control.
ToString
Description
Occurs when any button is clicked in the System.Web.UI.WebControls.DataList control.
The System.Web.UI.WebControls.DataList.ItemCommand event is raised when any button is clicked in the System.Web.UI.WebControls.DataList control and is commonly used when you have a button control with a custom CommandName value.
ToString
Occurs on the server when an item in the System.Web.UI.WebControls.DataList control is created.
The System.Web.UI.WebControls.DataList.ItemCreated event is raised when an item in the System.Web.UI.WebControls.DataList control is created, both during round-trips and at data bind time.
ToString
Occurs when an item is data bound to the System.Web.UI.WebControls.DataList control.
The System.Web.UI.WebControls.DataList.ItemDataBound event is raised after an item is data bound to the System.Web.UI.WebControls.DataList control. This event provides you with the last opportunity to access the data item before it is displayed on the client. After this event is raised, the data item is nulled out and no longer available.
ToString
Description
Occurs when the Update button is clicked for an item in the System.Web.UI.WebControls.DataList control.
The System.Web.UI.WebControls.DataList.UpdateCommand event is raised when the Update button for an item is clicked.
CreateControlHierarchy
CreateControlStyle
CreateItem
InitializeItem
LoadViewState
OnBubbleEvent
OnCancelCommand
Raises the System.Web.UI.WebControls.DataList.CancelCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataList.OnCancelCommand(System.Web.UI.WebControls.DataListCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataList.CancelCommand event. A System.Web.UI.WebControls.DataListCommandEventArgs that contains event data.
OnDeleteCommand
Raises the System.Web.UI.WebControls.DataList.DeleteCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataList.OnDeleteCommand(System.Web.UI.WebControls.DataListCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataList.DeleteCommand event. A System.Web.UI.WebControls.DataListCommandEventArgs that contains event data.
OnEditCommand
Raises the System.Web.UI.WebControls.DataList.EditCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataList.OnEditCommand(System.Web.UI.WebControls.DataListCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataList.EditCommand event. A System.Web.UI.WebControls.DataListCommandEventArgs that contains event data.
OnItemCommand
Raises the System.Web.UI.WebControls.DataList.ItemCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataList.OnItemCommand(System.Web.UI.WebControls.DataListCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataList.ItemCommand event. A System.Web.UI.WebControls.DataListCommandEventArgs that contains event data.
OnItemCreated
Raises the System.Web.UI.WebControls.DataList.ItemCreated event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataList.OnItemCreated(System.Web.UI.WebControls.DataListItemEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataList.ItemCreated event. A System.Web.UI.WebControls.DataListItemEventArgs that contains event data.
OnItemDataBound
Raises the System.Web.UI.WebControls.DataList.ItemDataBound event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataList.OnItemDataBound(System.Web.UI.WebControls.DataListItemEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataList.ItemDataBound event. A System.Web.UI.WebControls.DataListItemEventArgs that contains event data.
OnUpdateCommand
Raises the System.Web.UI.WebControls.DataList.UpdateCommand event. This allows you to provide a custom handler for the event.
Use the System.Web.UI.WebControls.DataList.OnUpdateCommand(System.Web.UI.WebControls.DataListCommandEventArgs) method to provide a custom handler for the System.Web.UI.WebControls.DataList.UpdateCommand event. A System.Web.UI.WebControls.DataListItemEventArgs that contains event data.
PrepareControlHierarchy
RenderContents
SaveViewState
IRepeatInfoUser.GetItemStyle
IRepeatInfoUser.RenderItem
TrackViewState
Marks the starting point to begin tracking and saving changes to the control as part of the control viewstate.
DataListCommandEventArgs class (System.Web.UI.WebControls)
TrackViewState
Description
Provides data for the System.Web.UI.WebControls.DataList.CancelCommand, System.Web.UI.WebControls.DataList.DeleteCommand, System.Web.UI.WebControls.DataList.EditCommand, System.Web.UI.WebControls.DataList.ItemCommand, and System.Web.UI.WebControls.DataList.UpdateCommand events of the System.Web.UI.WebControls.DataList control. This class cannot be inherited.
The System.Web.UI.WebControls.DataList.CancelCommand event is raised when the Cancel button for an item in the System.Web.UI.WebControls.DataList control is clicked.
DataListCommandEventArgs
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.DataListCommandEventArgs class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataListCommandEventArgs class. The selected item from the System.Web.UI.WebControls.DataList. The source of the command. A System.Web.UI.WebControls.CommandEventArgs that contains the original event data.
CommandArgument
CommandName
CommandSource
TrackViewState
Description
Gets the source of the command.
Use the System.Web.UI.WebControls.DataListCommandEventArgs.CommandSource property to determine the command source that raised the event. This property is commonly used to determine which command raises the event. You can then take appropriate action, based on the command.
Item
TrackViewState
Gets the item containing the command source in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataListCommandEventArgs.Item property to access information about the selected item in the System.Web.UI.WebControls.DataList control.
DataListCommandEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.DataList.CancelCommand, System.Web.UI.WebControls.DataList.DeleteCommand, System.Web.UI.WebControls.DataList.EditCommand, System.Web.UI.WebControls.DataList.ItemCommand, and System.Web.UI.WebControls.DataList.UpdateCommand events of a System.Web.UI.WebControls.DataList control. The source of the event. A System.Web.UI.WebControls.DataListCommandEventArgs that contains the event data.
The System.Web.UI.WebControls.DataList.CancelCommand event is raised when the Cancel button for an item in the System.Web.UI.WebControls.DataList control is clicked.
DataListItem class (System.Web.UI.WebControls)
ToString
Description
Represents an item in the System.Web.UI.WebControls.DataList control.
A System.Web.UI.WebControls.DataListItem object represents an item in the System.Web.UI.WebControls.DataList control, such as the heading section, the tooter section, or a data item.
DataListItem
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.DataListItem class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataListItem class. The index of the item in the System.Web.UI.WebControls.DataList control from the System.Web.UI.WebControls.DataList.Items collection. One of the System.Web.UI.WebControls.ListItemType values.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DataItem
ToString
Description
Gets or sets a data item associated with the System.Web.UI.WebControls.DataListItem object in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataListItem.DataItem property to specify or determine the properties of a data item associated with the System.Web.UI.WebControls.DataListItem object in the System.Web.UI.WebControls.DataList control.
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
ItemIndex
ToString
Description
Gets the index of the System.Web.UI.WebControls.DataListItem object from from the System.Web.UI.WebControls.DataList.Items collection of the control.
Use the System.Web.UI.WebControls.DataListItem.ItemIndex property to determine the index number of the System.Web.UI.WebControls.DataListItem object from the System.Web.UI.WebControls.DataList.Items collection.
ItemType
ToString
Gets the type of the item represented by the System.Web.UI.WebControls.DataListItem object in the System.Web.UI.WebControls.DataList control.
Use the System.Web.UI.WebControls.DataListItem.ItemType property to determine the type of the item represented by the System.Web.UI.WebControls.DataGridItem object. The following table lists the various item types.
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
CreateControlStyle
OnBubbleEvent
RenderItem
Displays the System.Web.UI.WebControls.DataListItem object on the client.
Use the System.Web.UI.WebControls.DataListItem.RenderItem(System.Web.UI.HtmlTextWriter,System.Boolean,System.Boolean) method to display the System.Web.UI.WebControls.DataListItem object on the client. A System.Web.UI.HtmlTextWriter object that contains the output stream for rendering on the client. true to extract rows; otherwise false. true to display as a table; otherwise false.
SetItemType
DataListItemCollection class (System.Web.UI.WebControls)
TrackViewState
Description
Represents the collection of System.Web.UI.WebControls.DataListItem objects in the System.Web.UI.WebControls.DataList control. This class cannot be inherited.
The System.Web.UI.WebControls.DataListItemCollection class represents a collection of System.Web.UI.WebControls.DataListItem objects, which in turn represent the data items in a System.Web.UI.WebControls.DataList control. To programmatically retrieve System.Web.UI.WebControls.DataListItem objects from a System.Web.UI.WebControls.DataList control, use one of the following methods: Use the indexer to get a single System.Web.UI.WebControls.DataListItem object from the collection, using array notation.
DataListItemCollection
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.DataListItemCollection class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataListItemCollection class. A System.Collections.ArrayList object that contains the items with which to initialize the collection.
Count
TrackViewState
Gets the number of System.Web.UI.WebControls.DataListItem objects in the collection.
Use the System.Web.UI.WebControls.DataListItemCollection.Count property to determine the number of System.Web.UI.WebControls.DataListItem objects in the System.Web.UI.WebControls.DataListItemCollection collection. The System.Web.UI.WebControls.DataListItemCollection.Count property is commonly used when iterating through the collection to determine the upper bound of the collection.
IsReadOnly
TrackViewState
Gets a value that indicates whether the System.Web.UI.WebControls.DataListItem objects in the System.Web.UI.WebControls.DataListItemCollection can be modified.
This property always returns false to indicate that the System.Web.UI.WebControls.DataListItemCollection can be written to in all cases.
IsSynchronized
TrackViewState
Gets a value indicating whether access to the System.Web.UI.WebControls.DataListItemCollection is synchronized (thread-safe).
This property is derived from the System.Collections.ICollection class and overridden to always return false.
Item
TrackViewState
Gets a System.Web.UI.WebControls.DataListItem object at the specified index in the collection.
Use this indexer to get a System.Web.UI.WebControls.DataListItem object from the System.Web.UI.WebControls.DataListItemCollection at the specified index using array notation. The index of the System.Web.UI.WebControls.DataListItem in the collection to retrieve.
SyncRoot
TrackViewState
Gets the object that can be used to synchronize access to the System.Web.UI.WebControls.DataListItemCollection collection.
The object returned in this implementation is the System.Web.UI.WebControls.DataListItemCollection object itself.
CopyTo
Copies all the items from this System.Web.UI.WebControls.DataListItemCollection collection to the specified System.Array object, starting at the specified index in the System.Array object.
Use this method to copy the contents of the System.Web.UI.WebControls.DataListItemCollection collection into the specified System.Array object, starting at the specified index. A zero-based System.Array object that receives the copied items from the System.Web.UI.WebControls.DataListItemCollection collection. The first position in the specified System.Array object to receive the copied contents.
GetEnumerator
Returns a System.Collections.IEnumerator interface that contains all System.Web.UI.WebControls.DataListItem objects in the System.Web.UI.WebControls.DataListItemCollection.
Return Value: A System.Collections.IEnumerator interface that contains all System.Web.UI.WebControls.DataListItem objects in the System.Web.UI.WebControls.DataListItemCollection.
Use this method to create a System.Collections.IEnumerator that can be easily iterated through to get each item in the System.Web.UI.WebControls.DataListItemCollection collection.
DataListItemEventArgs class (System.Web.UI.WebControls)
ToString
Description
Provides data for the System.Web.UI.WebControls.DataList.ItemCreated and System.Web.UI.WebControls.DataList.ItemDataBound events of a System.Web.UI.WebControls.DataList control. This class cannot be inherited.
The System.Web.UI.WebControls.DataList.ItemCreated event is raised when an item in the System.Web.UI.WebControls.DataList control is created.
DataListItemEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.DataListItemEventArgs class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DataListItemEventArgs class. A System.Web.UI.WebControls.DataListItem object that represents an item in the System.Web.UI.WebControls.DataList control.
Item
ToString
Gets the referenced item in the System.Web.UI.WebControls.DataList control when the event is raised.
The items in the System.Web.UI.WebControls.DataList control are referenced as each item is created or bound to the control. Use this property to programmatically access the referenced item in the System.Web.UI.WebControls.DataList control when the System.Web.UI.WebControls.DataList.ItemCreated or System.Web.UI.WebControls.DataList.ItemDataBound event is raised.
DataListItemEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.DataList.ItemCreated and System.Web.UI.WebControls.DataList.ItemDataBound events of the System.Web.UI.WebControls.DataList control. The source of the event. A System.Web.UI.WebControls.DataListItemEventArgs that contains the event data.
The System.Web.UI.WebControls.DataList.ItemCreated event is raised when an item in the System.Web.UI.WebControls.DataList control is created.
DayNameFormat enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the display format for the days of the week on a System.Web.UI.WebControls.Calendar control.
The System.Web.UI.WebControls.DayNameFormat enumeration represents the display formats for the days of the week on a System.Web.UI.WebControls.Calendar control.
ToString
The days of the week displayed with just the first letter. For example, T.
ToString
The days of the week displayed with just the first two letters. For example, Tu.
ToString
The days of the week displayed in full format. For example, Tuesday.
ToString
The days of the week displayed in abbreviated format. For example, Tues.
DayRenderEventArgs class (System.Web.UI.WebControls)
ToString
Description
Provides data for the System.Web.UI.WebControls.Calendar.DayRender event of the System.Web.UI.WebControls.Calendar control. This class cannot be inherited.
Although data binding is not supported for the System.Web.UI.WebControls.Calendar control, it is possible to modify the content and formatting of the individual date cells. Before the System.Web.UI.WebControls.Calendar control is displayed on the Web page, it creates and assembles the components that make up the control. The System.Web.UI.WebControls.Calendar.DayRender event is raised when each date cell in System.Web.UI.WebControls.Calendar control is created. You can control the contents and formatting of a date cell when it is created by providing code in the event handler for the System.Web.UI.WebControls.Calendar.DayRender event.
DayRenderEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.DayRenderEventArgs class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DayRenderEventArgs class. A System.Web.UI.WebControls.TableCell object that represents a cell in the System.Web.UI.WebControls.Calendar control. A System.Web.UI.WebControls.CalendarDay object that represents the day to render in the System.Web.UI.WebControls.Calendar control.
Cell
ToString
Gets the System.Web.UI.WebControls.TableCell object that represents the cell being rendered in the System.Web.UI.WebControls.Calendar control.
Use the System.Web.UI.WebControls.DayRenderEventArgs.Cell property to programmatically control the cell being rendered in the System.Web.UI.WebControls.Calendar control.
Day
ToString
Gets the System.Web.UI.WebControls.CalendarDay that represents the day being rendered in the System.Web.UI.WebControls.Calendar control.
Use the System.Web.UI.WebControls.DayRenderEventArgs.Day property to get information about the day being rendered in the System.Web.UI.WebControls.Calendar control.
DayRenderEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.Calendar.DayRender event of the System.Web.UI.WebControls.Calendar control. The source of the event. A System.Web.UI.WebControls.DayRenderEventArgs that contains the event data.
Although data binding is not supported for the System.Web.UI.WebControls.Calendar control, it is possible to modify the content and formatting of the individual date cells. Before the System.Web.UI.WebControls.Calendar control is displayed on the Web page, it creates and assembles the components that make up the control. The System.Web.UI.WebControls.Calendar.DayRender event is raised when each date cell in System.Web.UI.WebControls.Calendar control is created. You can control the contents and formatting of a date cell when it is created by providing code in the event handler for the System.Web.UI.WebControls.Calendar.DayRender event. For additional information on customizing the contents of a date cell, see System.Web.UI.WebControls.Calendar.OnDayRender(System.Web.UI.WebControls.TableCell,System.Web.UI.WebControls.CalendarDay).
DropDownList class (System.Web.UI.WebControls)
ToString
Description
Represents a control that allows the user to select a single item from a drop-down list.
Use the System.Web.UI.WebControls.DropDownList control to create a single selection drop-down list control. You can control the appearance of the System.Web.UI.WebControls.DropDownList control by setting the System.Web.UI.WebControls.DropDownList.BorderColor, System.Web.UI.WebControls.DropDownList.BorderStyle, and System.Web.UI.WebControls.DropDownList.BorderWidth properties.
DropDownList
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.DropDownList class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.DropDownList class.
AccessKey
Attributes
AutoPostBack
BackColor
BorderColor
ToString
Description
Gets or sets the border color of the control.
The System.Web.UI.WebControls.DropDownList.BorderColor property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.DropDownList control.
BorderStyle
ToString
Gets or sets the border style of the control.
The System.Web.UI.WebControls.DropDownList.BorderStyle property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.DropDownList control.
BorderWidth
ToString
Gets or sets the border width for the control.
The System.Web.UI.WebControls.DropDownList.BorderWidth property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.DropDownList control.
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DataMember
DataSource
DataTextField
DataTextFormatString
DataValueField
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
Items
NamingContainer
Page
Parent
SelectedIndex
ToString
Description
Gets or sets the index of the selected item in the System.Web.UI.WebControls.DropDownList control.
Use the System.Web.UI.WebControls.DropDownList.SelectedIndex property to programmatically specify or determine the index of the selected item from the System.Web.UI.WebControls.DropDownList control. An item is always selected in the System.Web.UI.WebControls.DropDownList control.
You cannot deselect every item in the list at the same time.
SelectedItem
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
ToString
Description
Gets or sets the ToolTip text displayed when the mouse pointer rests over the control.
The System.Web.UI.WebControls.DropDownList.ToolTip property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.DropDownList control.
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
Adds the properties of the System.Web.UI.WebControls.DropDownList control to the output stream for rendering on the client. The output stream for rendering on the client.
CreateControlCollection
RenderContents
Displays the System.Web.UI.WebControls.DropDownList control on the client. The output stream for rendering on the client.
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
EditCommandColumn class (System.Web.UI.WebControls)
TrackViewState
Description
A special column type for the System.Web.UI.WebControls.DataGrid control that contains the Edit command buttons for editing data items in each row.
Use the System.Web.UI.WebControls.EditCommandColumn class to create a special column for the System.Web.UI.WebControls.DataGrid control that contains the Edit, Update, and Cancel command buttons for each data row in the grid. These buttons allow you to edit the values of a row in the System.Web.UI.WebControls.DataGrid control.
EditCommandColumn
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.EditCommandColumn class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.EditCommandColumn class.
ButtonType
TrackViewState
Gets or sets the button type for the column.
Use the System.Web.UI.WebControls.EditCommandColumn.ButtonType property to specify whether the buttons in the column display as push buttons or hyperlinks.
CancelText
TrackViewState
Gets or sets the text to display for the Cancel command button in the System.Web.UI.WebControls.EditCommandColumn.
Use the System.Web.UI.WebControls.EditCommandColumn.CancelText property to specify the text to display for the Cancel command button in the System.Web.UI.WebControls.EditCommandColumn.
DesignMode
EditText
TrackViewState
Description
Gets or sets the text to display for the Edit command button in the System.Web.UI.WebControls.EditCommandColumn.
Use the System.Web.UI.WebControls.EditCommandColumn.EditText property to specify the text to display for the Edit command button in the System.Web.UI.WebControls.EditCommandColumn.
FooterStyle
FooterText
HeaderImageUrl
HeaderStyle
HeaderText
IsTrackingViewState
ItemStyle
Owner
SortExpression
UpdateText
TrackViewState
Description
Gets or sets the text to display for the Update command button in the System.Web.UI.WebControls.EditCommandColumn.
Use the System.Web.UI.WebControls.EditCommandColumn.UpdateText property to specify the text to display for the Update command button in the System.Web.UI.WebControls.EditCommandColumn.
ViewState
Visible
InitializeCell
Initializes a cell within the column. A System.Web.UI.WebControls.TableCell that contains information about the cell to initialize. The column number where the cell is located. One of the System.Web.UI.WebControls.ListItemType values.
FirstDayOfWeek enumeration (System.Web.UI.WebControls)
TrackViewState
Description
Specifies the day to display as the first day of the week on the System.Web.UI.WebControls.Calendar control.
The System.Web.UI.WebControls.FirstDayOfWeek enumeration represents the values that specify which day to display as the first day of the week on the System.Web.UI.WebControls.Calendar control.
TrackViewState
The first day of the week is specified by the system settings.
TrackViewState
The first day of the week is Friday.
TrackViewState
The first day of the week is Monday.
TrackViewState
The first day of the week is Saturday.
TrackViewState
The first day of the week is Sunday.
TrackViewState
The first day of the week is Thursday.
TrackViewState
The first day of the week is Tuesday.
TrackViewState
The first day of the week is Wednesday.
FontInfo class (System.Web.UI.WebControls)
ToString
Description
Encapsulates the font properties of text. This class cannot be inherited.
Use the System.Web.UI.WebControls.FontInfo class to encapsulate the font properties of text. You can specify the font name and the font size. You can also specify whether the style of the font is bold, italic, overlined, strikethrough, or underlined.
Bold
ToString
Gets or sets a value that indicates whether the font is bold.
Use the System.Web.UI.WebControls.FontInfo.Bold property to specify or determine whether the font is bold.
Italic
ToString
Gets or sets a value that indicates whether the font is italic.
Use the System.Web.UI.WebControls.FontInfo.Italic property to specify or determine whether the font is italic.
Name
ToString
Gets or sets the primary font name.
Use the System.Web.UI.WebControls.FontInfo.Name property to specify or determine the primary font name. The primary font name determines the font that is used to display text in the control associated with the System.Web.UI.WebControls.FontInfo.
Names
ToString
Gets or sets an ordered array of font names.
Use the System.Web.UI.WebControls.FontInfo.Names property to specify or determine an ordered array of font names for a System.Web.UI.WebControls.FontInfo. The System.Web.UI.WebControls.FontInfo.Names property is commonly used to store a list of available font names.
Overline
ToString
Gets or sets a value that indicates whether the font is overlined.
Use the System.Web.UI.WebControls.FontInfo.Overline property to specify or determine whether the font contains a line above the text.
Size
ToString
Gets or sets the font size.
Use the System.Web.UI.WebControls.FontInfo.Size property to specify the size of the font.
Strikeout
ToString
Gets or sets a value that indicates whether the font is strikethrough.
Use the System.Web.UI.WebControls.FontInfo.Strikeout property to specify or determine whether the font contains a line through the text.
Underline
ToString
Gets or sets a value that indicates whether the font is underlined.
Use the System.Web.UI.WebControls.FontInfo.Underline property to specify or determine whether the font contains a line under the text.
CopyFrom
Duplicates the font properties of the specified System.Web.UI.WebControls.FontInfo into the current instance of the System.Web.UI.WebControls.FontInfo class.
Use the System.Web.UI.WebControls.FontInfo.CopyFrom(System.Web.UI.WebControls.FontInfo) method to duplicate the font properties of the specified System.Web.UI.WebControls.FontInfo into the current instance of the System.Web.UI.WebControls.FontInfo class. A System.Web.UI.WebControls.FontInfo that contains the font properties to duplicate.
MergeWith
Combines the font properties of the specified System.Web.UI.WebControls.FontInfo with the current instance of the System.Web.UI.WebControls.FontInfo class.
Use the System.Web.UI.WebControls.FontInfo.MergeWith(System.Web.UI.WebControls.FontInfo) method to combine the font properties of the specified System.Web.UI.WebControls.FontInfo with the current instance of the System.Web.UI.WebControls.FontInfo class. A System.Web.UI.WebControls.FontInfo that contains the font properties to combine.
ShouldSerializeNames
Determines whether the System.Web.UI.WebControls.FontInfo.Names property contains enough entries to serialize.
Return Value: true if the System.Web.UI.WebControls.FontInfo.Names property contains enough entries to serialize; otherwise, false.
Use the System.Web.UI.WebControls.FontInfo.ShouldSerializeNames method to determine whether the System.Web.UI.WebControls.FontInfo.Names property contains enough entries to serialize.
ToString
Returns a string that contains the font name and size for an instance of the System.Web.UI.WebControls.FontInfo class.
Return Value: A string that contains the font name and size for an instance of the System.Web.UI.WebControls.FontInfo class.
Use the System.Web.UI.WebControls.FontInfo.ToString method to create a string that contains the font name and size, separated by a comma, for an instance of the System.Web.UI.WebControls.FontInfo class.
FontNamesConverter class (System.Web.UI.WebControls)
ToString
Description
Converts a string containing a list of font names to an array of strings containing the individual names. It also performs the reverse function.
Use the System.Web.UI.WebControls.FontNamesConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System. Object) method of this class to convert a single string containing a list of font names to an array of strings containing the individual names. Each font name in the string must be separated by a comma. For example, the string, “arial, times new roman, verdana”, converts to an array that contains the strings “arial”, “times new roman”, and “verdana”. Notice the commas are removed along with any white space at the beginning or end of the font name. White space in the middle of a font name is not removed.
FontNamesConverter
Example Syntax:
ToString
CanConvertFrom
Determines whether this converter can convert an object of the specified data type to an array of strings containing individual font names.
Return Value: true if the type can be converted; otherwise, false.
Use the System.Web.UI.WebControls.FontNamesConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type) method to determine whether the specified data type can be converted to an array of strings containing individual font names. A System.ComponentModel.ITypeDescriptorContext that provides information about the context of a type converter. You can optionally pass in null for this parameter. A System.Type that represents the data type to convert from. This parameter must be set to the string data type.
ConvertFrom
Converts a string that represents a list of font names into an array of strings containing individual font names.
Return Value: A System.Object that represents the array of strings containing the individual font names.
Use the System.Web.UI.WebControls.FontNamesConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System. Object) method to convert a single string containing a list of font names to an array of strings containing the individual names. Each font name in the string must be separated by a comma. For example, the string, “arial, times new roman, verdana”, converts to an array that contains the strings “arial”, “times new roman”, and “verdana”. Notice that the commas are removed along with any white space at the beginning or end of the font name. White space in the middle of a font name is not removed. A System.ComponentModel.ITypeDescriptorContext that provides information about the context of a type converter. This parameter is not used in this method. It is reserved for future versions of this method. You can optionally pass in null for this parameter. A System.Globalization.CultureInfo object that represents information about a culture such as language, calendar system, and so on. This parameter is not used in this method. It is reserved for future versions of this method. You can optionally pass in null for this parameter. A System.Object that represents the source string to convert from.
ConvertTo
Creates a string that represents a list of font names from an array of strings containing individual font names.
Return Value: A System.Object that represents a string containing a list of font names.
Use the System.Web.UI.WebControls.FontNamesConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System. Object,System.Type) method to convert an array of strings containing the individual font names to a single string containing a list of the names. For example, an array that contains the strings “arial”, “times new roman”, and “verdana” converts to the string, “arial,times new roman,verdana”. Notice that commas are automatically inserted between the font names without any white space. A System.ComponentModel.ITypeDescriptorContext object that provides information about the context of a type converter. This parameter is not used in this method. It is reserved for future versions of this method. You can optionally pass in null for this parameter. A System.Globalization.CultureInfo object that represents information about a culture such as language, calendar system, and so on. This parameter is not used in this method. It is reserved for future versions of this method. You can optionally pass in null for this parameter. A System.Object that represents the source array of strings to convert from. A System.Type object that represents the data type to convert to. This parameter must be set to the string data type.
FontSize enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the font sizes defined by HTML 4.0.
The System.Web.UI.WebControls.FontSize enumeration represents the font sizes defined by HTML 4.0. The font size can be an absolute or relative size.
ToString
The font size is specified by a point value.
ToString
The font size is two sizes larger than the base font size.
ToString
The font size is one size larger than the parent element.
ToString
The font size is one size larger than the default font size.
ToString
The font size is not set.
ToString
The base font size determined by the browser.
ToString
The font size is one size smaller than the parent element.
ToString
The font size is three sizes larger than the base font size.
ToString
The font size is one size smaller than the base font size.
ToString
The font size is four sizes larger than the base font size.
ToString
The font size is two sizes smaller than the base font size.
FontUnit structure (System.Web.UI.WebControls)
ToString
Description
Represents the size of a font.
For a list of initial property values for an instance of System.Web.UI.WebControls.FontUnit, see the System.Web.UI.WebControls.FontUnit.#ctor constructor.
ToString
Represents an empty System.Web.UI.WebControls.FontUnit object. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.Empty field to represent an empty System.Web.UI.WebControls.FontUnit object. No HTML rendered output is created when this field is used.
ToString
Represents a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Large font. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.Large field to represent a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Large.
ToString
Represents a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Larger font. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.Larger field to represent a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Larger.
ToString
Represents a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Medium font. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.Medium field to represent a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Medium ToString
Represents a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Small font. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.Small field to represent a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Small.
ToString
Represents a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Smaller font. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.Smaller field to represent a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.Smaller
ToString
Represents a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.XLarge font. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.XLarge field to represent a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.XLarge.
ToString
Represents a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.XSmall font. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.XSmall field to represent a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.XSmall.
ToString
Represents a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.XXLarge font. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.XXLarge field to represent a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.XXLarge.
ToString
Represents a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.XXSmall font. This field is read only.
Use the System.Web.UI.WebControls.FontUnit.XXSmall field to represent a System.Web.UI.WebControls.FontUnit object with the System.Web.UI.WebControls.FontUnit.Type property set to FontSize.XXSmall.
FontUnit
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.FontUnit class with the specified System.Web.UI.WebControls.FontSize object.
Use this constructor to create and initialize an instance of the System.Web.UI.WebControls.FontUnit class using the specified System.Web.UI.WebControls.FontSize object. One of the System.Web.UI.WebControls.FontSize values.
FontUnit
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.FontUnit class with the specified font size.
Use this constructor to create and initialize an instance of the System.Web.UI.WebControls.FontUnit class using the specified font size. An integer that represents the size of the font.
FontUnit
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.FontUnit class with the specified font value.
Use this constructor to create and initialize an instance of the System.Web.UI.WebControls.FontUnit class using the specified font value. A string representation of one of the System.Web.UI.WebControls.FontSize value.
FontUnit Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.FontUnit class with the specified System.Web.UI.WebControls.Unit object.
Use this constructor to create and initialize an instance of the System.Web.UI.WebControls.FontUnit class using the specified System.Web.UI.WebControls.Unit object. A System.Web.UI.WebControls.Unit object that specifies the font size.
FontUnit
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.FontUnit class with the specified font value and System.Globalization.CultureInfo object.
Use this constructor to create and initialize an instance of the System.Web.UI.WebControls.FontUnit class using the specified font value and System.Globalization.CultureInfo object. A string representation of one of the System.Web.UI.WebControls.FontSize value. A System.Globalization.CultureInfo object that represents the culture to create the System.Web.UI.WebControls.FontUnit object for.
IsEmpty
ToString
Gets a value that indicates whether the font size has been set.
The System.Web.UI.WebControls.FontUnit.IsEmpty property is commonly used to determine whether the font size has been set.
Type
ToString
Gets a System.Web.UI.WebControls.FontSize object that represents the font size.
Use the System.Web.UI.WebControls.FontUnit.Type property to determine the font size.
Unit
ToString
Gets a System.Web.UI.WebControls.Unit object that represents the font size.
Equals
Determines whether the specified System.Object is equivilent to this instance of the System.Web.UI.WebControls.FontUnit class.
Return Value: true if the specified System.Object is equivilent to this instance of the System.Web.UI.WebControls.FontUnit class; otherwise, false. A System.Object that contains the object to compare to this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
op_Equality
Compares two System.Web.UI.WebControls.FontUnit objects for equality.
Return Value: true if both System.Web.UI.WebControls.FontUnit objects are equal; otherwise, false. A System.Web.UI.WebControls.FontUnit object that contains font properties on the left of the operator. A System.Web.UI.WebControls.FontUnit object that contains font properties on the right of the operator.
op_Implicit
Implicitly creates a System.Web.UI.WebControls.FontUnit of type System.Drawing.Point from an integer value. An integer representing the System.Drawing.Point value to convert into a System.Web.UI.WebControls.FontUnit.
op_Inequality
Compares two System.Web.UI.WebControls.FontUnit objects for inequality.
Return Value: true if both System.Web.UI.WebControls.FontUnit objects are not equal; otherwise, false. A System.Web.UI.WebControls.FontUnit that contains font properties on the left of the operator. A System.Web.UI.WebControls.FontUnit that contains font properties on the right of the operator.
Parse
Converts the specified string to its default System.Web.UI.WebControls.FontUnit equivalent. A string representation of one of the System.Web.UI.WebControls.FontSize value.
Parse
Converts the specified string to its System.Web.UI.WebControls.FontUnit equivalent in the specified culture. A string representation of one of the System.Web.UI.WebControls.FontSize value. A System.Globalization.CultureInfo object that represents the culture of the System.Web.UI.WebControls.FontUnit object.
Point
Creates a System.Web.UI.WebControls.FontUnit of type System.Drawing.Point from an integer value.
Return Value: A System.Web.UI.WebControls.FontUnit that represents the new font size. An integer representing the System.Drawing.Point value to convert into a System.Web.UI.WebControls.FontUnit.
ToString
Converts the System.Web.UI.WebControls.FontUnit object to the default string representation.
Return Value: A string representation of the System.Web.UI.WebControls.FontUnit object.
ToString
Converts the System.Web.UI.WebControls.FontUnit object to a string representation using the specified System.Globalization.CultureInfo object. A System.Globalization.CultureInfo object that contains the culture.
FontUnitConverter class (System.Web.UI.WebControls)
ToString
Description
Converts a System.Web.UI.WebControls.FontUnit to and from a specified data type.
FontUnitConverter
Example Syntax:
ToString
CanConvertFrom
Determines if the specified data type can be converted to a System.Web.UI.WebControls.FontUnit.
Return Value: true if the type can be converted; otherwise false. An System.ComponentModel.ITypeDescriptorContext that provides information about the context of a type converter. A System.Type that represents the data type to check.
ConvertFrom
Converts the specified System.Object into a System.Web.UI.WebControls.FontUnit. An System.ComponentModel.ITypeDescriptorContext that provides information about the context of a type converter. A System.Globalization.CultureInfo object that represents information about a culture such as language, calendar system, and so on. This parameter is not used in this method. It is reserved for future versions of this method. You can optionally pass in null for this parameter. The System.Object to convert to a System.Web.UI.WebControls.FontUnit.
ConvertTo
Converts the specified System.Web.UI.WebControls.FontUnit into the specified System.Type. An System.ComponentModel.ITypeDescriptorContext that provides information about the context of a type converter. A System.Globalization.CultureInfo object that represents information about a culture such as language, calendar system, and so on. This parameter is not used in this method. It is reserved for future versions of this method. You can optionally pass in null for this parameter. A System.Object that represents the source array of strings to convert from. A System.Type that represents the data type to convert to.
GetStandardValues
Returns a System.ComponentModel.TypeConverter.StandardValuesCollection containing standard System.Web.UI.WebControls.FontUnit values.
Return Value: A System.ComponentModel.TypeConverter.StandardValuesCollection containing System.Web.UI.WebControls.FontUnit values. An System.ComponentModel.ITypeDescriptorContext that provides information about the context of a type converter.
GetStandardValuesExclusive
Indicates whether the specified context contains exclusive standard values.
Return Value: false for all cases. An System.ComponentModel.ITypeDescriptorContext that provides information about the context of a type converter.
GetStandardValuesSupported
Indicates whether the specified context contains suppurted standard values.
Return Value: true for all cases. An System.ComponentModel.ITypeDescriptorContext that provides information about the context of a type converter.
GridLines enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the grid line styles for controls displaying items in a table structure.
The System.Web.UI.WebControls.GridLines enumeration represents the grid line styles for controls displaying items in a table structure.
ToString
Both horizontal and vertical grid lines rendered.
ToString
Only horizontal grid lines rendered.
ToString
No grid lines rendered.
ToString
Only vertical grid lines rendered.
HorizontalAlign enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the horizonal alignment of items within a container.
The System.Web.UI.WebControls.HorizontaAlign enumeration represents the horizontal alignment options for items within a container, such as a System.Web.UI.WebControls.TableCell.
ToString
The contents of a container are centered.
ToString
The contents of a container are uniformly spread out and aligned with both the left and right margins.
ToString
The contents of a container are left justified.
ToString
The horizontal alignment is not set.
ToString
The contents of a container are right justified.
HyperLink class (System.Web.UI.WebControls)
ToString
Description
A control that displays a link to another Web page.
Use the System.Web.UI.WebControls.HyperLink control to create a link to another Web page. The System.Web.UI.WebControls.HyperLink control is typically displayed as text specified by the System.Web.UI.WebControls.HyperLink.Text property. It can also be displayed as an image specified by the System.Web.UI.WebControls.HyperLink.ImageUrl property.
HyperLink
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.HyperLink class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.HyperLink control.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
ImageUrl
ToString
Description
Gets or sets the path to an image to display for the System.Web.UI.WebControls.HyperLink control.
The System.Web.UI.WebControls.HyperLink control can be displayed as text or an image. Use the System.Web.UI.WebControls.HyperLink.ImageUrl property to specify an image to display for the System.Web.UI.WebControls.HyperLink control.
IsTrackingViewState
NamingContainer
NavigateUrl
ToString
Description
Gets or sets the URL to link to when the System.Web.UI.WebControls.HyperLink control is clicked.
Use the System.Web.UI.WebControls.HyperLink.NavigateUrl property to specify the URL to navigate to when the System.Web.UI.WebControls.HyperLink control is clicked.
Page
Parent
Site
Style
TabIndex
TagKey
TagName
Target
ToString
Description
Gets or sets the target window or frame to display the Web page content linked to when the System.Web.UI.WebControls.HyperLink control is clicked.
Use the System.Web.UI.WebControls.HyperLink.Target property to specify the frame or window that displays the Web page linked to when the System.Web.UI.WebControls.HyperLink control is clicked. The Web page is specified by setting the System.Web.UI.WebControls.HyperLink.NavigateUrl property.
TemplateSourceDirectory
Text
ToString
Description
Gets or sets the text caption for the System.Web.UI.WebControls.HyperLink control.
The System.Web.UI.WebControls.HyperLink control can be displayed as text or an image. Use the System.Web.UI.WebControls.HyperLink.Text property to specify the text to display for the System.Web.UI.WebControls.HyperLink control.
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
Adds the attribututes of the a System.Web.UI.WebControls.HyperLink to the output stream for rendering. The output stream to render on the client.
AddParsedSubObject
LoadViewState
Load previously saved state. Overridden to synchronize Text property with LiteralContent.
RenderContents
Displays the System.Web.UI.WebControls.HyperLink on a page. The output stream to render on the client.
HyperLinkColumn class (System.Web.UI.WebControls)
TrackViewState
Description
A column type for the System.Web.UI.WebControls.DataGrid control that contains a hyperlink for each item in the column.
Use the System.Web.UI.WebControls.HyperLinkColumn column type in a System.Web.UI.WebControls.DataGrid control to create a hyperlink for each row in the System.Web.UI.WebControls.DataGrid control. Set the System.Web.UI.WebControls.HyperLinkColumn.Text property to specify the caption text for the hyperlink. To specify the URL to navigate to when the hyperlink is clicked, set the System.Web.UI.WebControls.HyperLinkColumn.NavigateUrl property.
HyperLinkColumn
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.HyperLinkColumn class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.HyperLinkColumn class.
DataNavigateUrlField
TrackViewState
Gets or sets the field name from a data source to bind to the URL of the hyperlinks in System.Web.UI.WebControls.HyperLinkColumn column.
DataNavigateUrlFormatString
TrackViewState
Gets or sets the string that specifies the display format for the URL of the hyperlinks in the System.Web.UI.WebControls.HyperLinkColumn column.
Use the System.Web.UI.WebControls.HyperLinkColumn.DataNavigateUrlFormatString property to provide a custom format for the URL of the hyperlinks in the System.Web.UI.WebControls.HyperLinkColumn column.
DataTextField
TrackViewState
Gets or sets the field name from a data source to bind to the text caption of the hyperlinks in System.Web.UI.WebControls.HyperLinkColumn column.
DataTextFormatString
TrackViewState
Gets or sets the string that specifies the display format for the text caption of the hyperlinks in the System.Web.UI.WebControls.HyperLinkColumn column.
Use the System.Web.UI.WebControls.HyperLinkColumn.DataTextFormatString property to provide a custom format for the items in the column.
DesignMode
FooterStyle
FooterText
HeaderlmageUrl
HeaderStyle
HeaderText
IsTrackingViewState
ItemStyle
NavigateUrl
TrackViewState
Description
Gets or sets the URL to link to when a hyperlink in the column is clicked.
Use the System.Web.UI.WebControls.HyperLinkColumn.NavigateUrl property to specify the URL to navigate to when a hyperlink in the column is clicked.
Owner
SortExpression
Target
TrackViewState
Description
Gets or sets the target window or frame to display the Web page content linked to when the hyperlink in the column is clicked.
Use the System.Web.UI.WebControls.HyperLinkColumn.Target property to specify the frame or window that displays the Web page linked to when a hyperlink in the column is clicked.
Text
TrackViewState
Gets or sets the text caption to display for the hyperlinks in the column.
Use the System.Web.UI.WebControls.HyperLinkColumn.Text property to specify the text caption to display for the hyperlinks in the column.
ViewState
Visible
FormatDataNavigateUrlValue
FormatDataTextValue
Initialize
InitializeCell
Initializes the cell representing this column with the contained hyperlink.
HyperLinks are created for all items in the DataGrid except the Header and Footer items. The cell to be initialized. The index of the column that contains the cell. The type of item that the cell is part of.
HyperLinkControlBuilder class (System.Web.UI.WebControls)
TrackViewState
Description
Interacts with the parser to build a System.Web.UI.WebControls.HyperLink control.
To create a custom control builder for a System.Web.UI.WebControls.HyperLink derived control, you need to inherit from this class.
HyperLinkControlBuilder
Example Syntax:
TrackViewState
ControlType
FChildrenAsProperties
FIsNonParserAccessor
HasAspCode
ID
InDesigner
NamingContainerType
Parser
TagName
AllowWhitespaceLiterals
Gets a value that indicates whether white spaces are allowed in literals for this control.
Return Value: Overloaded to always returns false to indicate that white spaces are not allowed.
This method overrides the System.Web.UI.ControlBuilder.AllowWhitespaceLiterals property to ignore white space in the System.Web.UI.WebControls.HyperLink control.
Image class (System.Web.UI.WebControls)
ToString
Description
Displays an image on a Web page.
Use the System.Web.UI.WebControls.Image control to display an image on the Web page. The path to the displayed image is specified by setting the System.Web.UI.WebControls.Image.ImageUrl property. You can specify the text to display in place of image when the image is not available by setting the System.Web.UI.WebControls.Image.AlternateText property. The alignment of the image in relation to other elements on the Web page is specified by setting System.Web.UI.WebControls.Image.ImageAlign property.
Image
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Image class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.Image class.
AccessKey
AlternateText
ToString
Description
Gets or sets the alternate text displayed in the System.Web.UI.WebControls.Image control when the image is unavailable. Browsers that support the ToolTips feature display this text as a ToolTip.
Use this property to specify the text to display if the image specified in the System.Web.UI.WebControls.Image.ImageUrl property is not available. In browsers that support the ToolTips feature, this text also displays as a ToolTip.
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
ToString
Description
Gets or sets a value indicating whether the control is enabled.
This property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.Image control.
EnableViewState
Events
Font
ToString
Description
Gets the font properties for the text associated with the control.
This property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.Image control.
ForeColor
HasChildViewState
Height
ID
ImageAlign
ToString
Description
Gets or sets the alignment of the System.Web.UI.WebControls.Image control in relation to other elements on the Web page.
Use the System.Web.UI.WebControls.Image.ImageAlign property to specify or determine the alignment of the image in relation to other elements on the Web page. The following table lists the possible alignments.
ImageUrl
ToString
Gets or sets the location of an image to display in the System.Web.UI.WebControls.Image control.
Use the System.Web.UI.WebControls.Image.ImageUrl property to specify the URL of an image to display in the System.Web.UI.WebControls.Image control. You can use a relative or an absolute URL. A relative URL relates the location of the image to the location of the Web page without specifying a complete path on the server. The path is relative to the location of the Web page. This makes it easier to move the entire site to another directory on the server without updating the code. An absolute URL provides the complete path, so moving the site to another directory requires that you update the code.
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
Adds the attributes of an System.Web.UI.WebControls.Image to the output stream for rendering on the client. A System.Web.UI.HtmlTextWriter that contains the output stream to render on the client browser.
RenderContents
ImageAlign enumeration (System.Web.UI.WebControls)
TrackViewState
Description
Specifies the alignment of an image in relation to the text of a Web page.
The System.Web.UI.WebControls.ImageAlign enumeration represents the alignment options for an image relative to the text of a Web page.
TrackViewState
The lower edge of the image is aligned with the lower edge of the largest element on the same line.
TrackViewState
The middle of the image is aligned with the middle of the largest element on the same line.
TrackViewState
The lower edge of the image is aligned with the lower edge of the first line of text.
TrackViewState
The lower edge of the image is aligned with the lower edge of the first line of text.
TrackViewState
The image is aligned on the left edge of the Web page with text wrapping on the right.
TrackViewState
The middle of the image is aligned with the lower edge of the first line of text.
TrackViewState
The alignment is not set.
TrackViewState
The image is aligned on the right edge of the Web page with text wrapping on the left.
TrackViewState
The upper edge of the image is aligned with the upper edge of the highest text on the same line.
TrackViewState
The upper edge of the image is aligned with the upper edge of the highest element on the same line.
ImageButton class (System.Web.UI.WebControls)
ToString
Description
A control that displays an image and responds to mouse clicks on the image.
Use the System.Web.UI.WebControls.ImageButton control to display an image that responds to mouse clicks.
ImageButton
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.ImageButton class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.ImageButton class.
AccessKey
AlternateText
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
CausesValidation
ToString
Description
Gets or sets a value indicating whether validation is performed when the System.Web.UI.WebControls.ImageButton control is clicked.
By default, page validation is performed when a System.Web.UI.WebControls.ImageButton control is clicked. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control.
ChildControlsCreated
ClientID
CommandArgument
ToString
Description
Gets or sets an optional argument that provides additional information about the System.Web.UI.WebControls.ImageButton.CommandName property.
Sometimes, multiple System.Web.UI.WebControls.ImageButton controls are related and share the same value for the System.Web.UI.WebControls.ImageButton.CommandName property, such as Sort. Use this property to supplement the System.Web.UI.WebControls.ImageButton.CommandName property with additional information about the command to perform, such as Ascending. The values of the System.Web.UI.WebControls.ImageButton.CommandName and System.Web.UI.WebControls.ImageButton.CommandArgument properties are typically used in the System.Web.UI.WebControls.ImageButton.OnCommand(System.Web.UI.WebControls.CommandEventArgs) event handler to determine the action to perform when the System.Web.UI.WebControls.ImageButton control is clicked.
CommandName
ToString
Gets or sets the command name associated with the System.Web.UI.WebControls.ImageButton control.
Use this property to specify the command to perform when the System.Web.UI.WebControls.ImageButton control is clicked, such as Sort, Cancel, and Edit. This allows multiple System.Web.UI.WebControls.ImageButton controls to be placed on the same Web page. The value in this property can then be programmatically identified in the System.Web.UI.WebControls.ImageButton.OnCommand(System.Web.UI.WebControls.CommandEventArgs) event handler to determine the appropriate action to perform when each System.Web.UI.WebControls.ImageButton control is clicked.
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
ImageAlign
ImageUrl
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
ToString
Description
Gets a value that represents the tag HtmlTextWriterTag.Input. This property is read-only.
Overrides the base implementation and returns the tag HtmlTextWriterTag.Input instead of the default HtmlTextWriterTag.Img Gets a value that represents the tag HtmlTextWriterTag.Input. This property is read-only.
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
ToString
Description
Occurs when the System.Web.UI.WebControls.ImageButton is clicked.
The System.Web.UI.WebControls.ImageButton.Click event is raised when the System.Web.UI.WebControls.ImageButton control is clicked.
ToString
Occurs when the System.Web.UI.WebControls.ImageButton is clicked.
The System.Web.UI.WebControls.ImageButton.Command event is raised when an System.Web.UI.WebControls.ImageButton control is clicked.
AddAttributesToRender
Adds the attributes of an System.Web.UI.WebControls.ImageButton to the output stream for rendering on the client. The output stream to render on the client.
OnClick
Raises the System.Web.UI.WebControls.ImageButton.Click event and allows you to handle the System.Web.UI.WebControls.ImageButton.Click event directly.
The System.Web.UI.WebControls.ImageButton.Click event is raised when the System.Web.UI.WebControls.ImageButton control is clicked. By using the System.Web.UI.WebControls.ImageButton.OnClick(System.Web.UI.ImageClickEventArgs) event handler, you can programmatically determine the coordinates where the image is clicked. You can then code a response, based on the values of these coordinates. Note the origin (0, 0) is located at the upper left corner of the image. A System.Web.UI.ImageClickEventArgs that contains the event data.
OnCommand
Raises the System.Web.UI.WebControls.ImageButton.Command event and allows you to handle the System.Web.UI.WebControls.ImageButton.Command event directly.
The System.Web.UI.WebControls.ImageButton.Command event is raised when the System.Web.UI.WebControls.ImageButton control is clicked. The System.Web.UI.WebControls.ImageButton.OnCommand(System.Web.UI.WebControls.CommandEventArgs) event handler is used to make the System.Web.UI.WebControls.ImageButton control behave like a command button. A command name can be associated with the control by using the System.Web.UI.WebControls.ImageButton.CommandName property. This allows multiple System.Web.UI.WebControls.ImageButton controls to be placed on the Web page. The value in this property can then be programmatically identified in the System.Web.UI.WebControls.ImageButton.OnCommand(System.Web.UI.WebControls.CommandEventArgs) event handler to determine the appropriate action to perform when each System.Web.UI.WebControls.ImageButton control is clicked. The System.Web.UI.WebControls.ImageButton.CommandArgument property can also be used to pass additional information about the command, such as specifying ascending order. A System.Web.UI.WebControls.CommandEventArgs that contains the event data.
OnPreRender
Determine if the image has been clicked prior to rendering on the client.
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
IPostBackEventHandler.RaisePostBackEvent
IRepeatInfoUser interface (System.Web.UI.WebControls)
TrackViewState
Description
Specifies a contract for implementing System.Web.UI.WebControls.Repeater objects in list controls.
HasFooter
TrackViewState
Indicates whether the Repeater contains a tooter item.
HasHeader
TrackViewState
Indicates whether the System.Web.UI.WebControls.Repeater contains a header item.
HasSeparators
TrackViewState
Indicates whether the Repeater contains separator items.
RepeatedItemCount
TrackViewState
Specifies the item count of the Repeater.
GetItemStyle
Retrieves the item style with the specified item type and location within the System.Web.UI.WebControls.Repeater.
Return Value: A System.Web.UI.WebControls.Style that represents the Repeater item style. A System.Web.UI.WebControls.ListItemType that represents the specified type of the System.Web.UI.WebControls.Repeater item. An ordinal index that specifies the location of the item within the System.Web.UI.WebControls.Repeater.
RenderItem
Renders the System.Web.UI.WebControls.Repeater item with the specified information. A System.Web.UI.WebControls.ListItemType that represents the specified type of the System.Web.UI.WebControls.Repeater item. An ordinal index that specifies the location of the item within the System.Web.UI.WebControls.Repeater. A System.Web.UI.WebControls.RepeatInfo that represents the information used to render items using a System.Web.UI.WebControls.Repeater. The output stream that renders HTML content to the client.
Label class (System.Web.UI.WebControls)
RenderItem
Description
Represents a label control, which displays text on a Web page.
Use the System.Web.UI.WebControls.Label control to display text in a set location on the page. Unlike static text, you can customize the displayed text through the System.Web.UI.WebControls.Label.Text property.
Label
Example Syntax:
RenderItem
Initializes a new instance of the System.Web.UI.WebControls.Label class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.Label class.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
RenderItem
Description
Gets or sets the text content of the System.Web.UI.WebControls.Label control.
Use the System.Web.UI.WebControls.Label.Text property to specify or determine the text content of the System.Web.UI.WebControls.Label control. This property is commonly used to programmatically customize the text that is displayed in the System.Web.UI.WebControls.Label control.
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddParsedSubObject
LoadViewState
Load previously saved state. Overridden to synchronize Text property with LiteralContent. Represents the previously saved state.
RenderContents
Renders the contents of the System.Web.UI.WebControls.Label into the specified writer. The output stream that renders HTML content to the client.
LabelControlBuilder class (System.Web.UI.WebControls)
TrackViewState
Description
Interacts with the parser to build a System.Web.UI.WebControls.Label control.
To create a custom control builder for a System.Web.UI.WebControls.Label derived control, you need to inherit from this class.
LabelControlBuilder
Example Syntax:
TrackViewState
ControlType
FChildrenAsProperties
FIsNonParserAccessor
HasAspCode
ID
InDesigner
NamingContainerType
Parser
TagName
AllowWhitespaceLiterals
Specifies whether white space literals are allowed.
Return Value: false for all cases.
This method overrides the System.Web.UI.ControlBuilder.AllowWhitespaceLiterals property to ignore white space in the System.Web.UI.WebControls.Label control.
LinkButton class (System.Web.UI.WebControls)
ToString
Description
Displays a hyperlink style button control on a Web page.
Use the System.Web.UI.WebControls.LinkButton control to create a hyperlink style button on the Web page. You can create either a submit button or a command button.
LinkButton
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.LinkButton class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.LinkButton control.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
CausesValidation
ToString
Description
Gets or sets a value indicating whether validation is performed when the System.Web.UI.WebControls.LinkButton control is clicked.
By default, page validation is performed when a System.Web.UI.WebControls.LinkButton control is clicked. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control.
ChildControlsCreated
ClientID
CommandArgument
ToString
Description
Gets or sets an optional argument passed to the System.Web.UI.WebControls.LinkButton.Command event handler along with the associated System.Web.UI.WebControls.LinkButton.CommandName property.
Use the System.Web.UI.WebControls.LinkButton.CommandArgument property to specify an argument that complements the System.Web.UI.WebControls.LinkButton.CommandName property.
CommandName
ToString
Gets or sets the command name associated with the System.Web.UI.WebControls.LinkButton control. This value is passed to the System.Web.UI.WebControls.LinkButton.Command event handler along with the System.Web.UI.WebControls.LinkButton.CommandArgument property.
When you have multiple System.Web.UI.WebControls.LinkButton controls on a Web page, use the System.Web.UI.WebControls.LinkButton.CommandName property to specify or determine the command name associated with the System.Web.UI.WebControls.LinkButton control clicked. You can set the System.Web.UI.WebControls.LinkButton.CommandName property with any string that identifies the command to perform. You can then programmatically determine the command name of the System.Web.UI.WebControls.LinkButton control and perform the appropriate actions.
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToString
Description
Gets or sets the text caption displayed on the System.Web.UI.WebControls.LinkButton control.
Use the System.Web.UI.WebControls.LinkButton.Text property to specify or determine the caption to display on the System.Web.UI.WebControls.LinkButton control.
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
ToString
Description
Occurs when the System.Web.UI.WebControls.LinkButton control is clicked.
The System.Web.UI.WebControls.LinkButton.Click event is raised when the System.Web.UI.WebControls.LinkButton control is clicked. This event is commonly used when no command name is associated with the System.Web.UI.WebControls.LinkButton control, such as a submit button.
ToString
Occurs when the System.Web.UI.WebControls.Button control is clicked.
The System.Web.UI.WebControls.LinkButton.Command event is raised when the System.Web.UI.WebControls.LinkButton control is clicked. This event is commonly used when a command name, such as Sort, is associated with the System.Web.UI.WebControls.LinkButton control. This allows you to create multiple System.Web.UI.WebControls.LinkButton controls on a Web page and programmatically determine which System.Web.UI.WebControls.LinkButton control is clicked.
AddAttributesToRender
Render the attributes on the begin tag.
AddParsedSubObject
LoadViewState
Load previously saved state. Overridden to synchronize Text property with LiteralContent.
OnClick
Raises the System.Web.UI.WebControls.LinkButton.Click event of the System.Web.UI.WebControls.LinkButton control.
The System.Web.UI.WebControls.LinkButton.Click event is raised when the System.Web.UI.WebControls.LinkButton control is clicked. This event is commonly used when no command name is associated with the System.Web.UI.WebControls.LinkButton control, such as a submit button. A System.EventArgs that contains the event data.
OnCommand
Raises the System.Web.UI.WebControls.LinkButton.Command event of the System.Web.UI.WebControls.LinkButton control.
The System.Web.UI.WebControls.LinkButton.Command event is raised when the System.Web.UI.WebControls.LinkButton control is clicked. This event is commonly used when a command name, such as Sort, is associated with the System.Web.UI.WebControls.LinkButton control. This allows you to create multiple System.Web.UI.WebControls.LinkButton controls on a Web page and programmatically determine which System.Web.UI.WebControls.LinkButton control is clicked. A System.Web.UI.WebControls.CommandEventArgs that contains the event data.
RenderContents
The output stream that renders HTML content to the client.
IPostBackEventHandler.RaisePostBackEvent
LinkButtonControlBuilder class (System.Web.UI.WebControls)
TrackViewState
Description
Interacts with the parser to build a System.Web.UI.WebControls.LinkButton control.
To create a custom control builder for a System.Web.UI.WebControls.LinkButton derived control, you need to inherit from this class.
LinkButtonControlBuilder
Example Syntax:
TrackViewState
ControlType
FChildrenAsProperties
FIsNonParserAccessor
HasAspCode
ID
InDesigner
NamingContainerType
Parser
TagName
AllowWhitespaceLiterals
Specifies whether white space literals are allowed.
Return Value: false for all cases.
This method overrides System.Web.UI.ControlBuilder.AllowWhitespaceLiterals to ignore white space in the System.Web.UI.WebControls.LinkButton control.
ListBox class (System.Web.UI.WebControls)
ToString
Description
Represents a list box control that allows single or multiple item selection.
Use the System.Web.UI.WebControls.ListBox control to create a list control that allows single or multiple item selection. Use the System.Web.UI.WebControls.ListBox.Rows property to specify the height of the control. To enable multiple item selection, set the System.Web.UI.WebControls.ListBox.SelectionMode property to ListSelectionMode.Multiple.
ListBox
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.ListBox class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.ListBox class.
AccessKey
Attributes
AutoPostBack
BackColor
BorderColor
ToString
Description
Gets or sets the border color of the control.
The System.Web.UI.WebControls.ListBox.BorderColor property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.ListBox control.
BorderStyle
ToString
Gets or sets the border style of the control.
The System.Web.UI.WebControls.ListBox.BorderStyle property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.ListBox control.
BorderWidth
ToString
Gets or sets the border width for the control.
The System.Web.UI.WebControls.ListBox.BorderWidth property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.ListBox control.
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DataMember
DataSource
DataTextField
DataTextFormatString
DataValueField
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
Items
NamingContainer
Page
Parent
Rows
ToString
Description
Gets or sets the number of rows displayed in the System.Web.UI.WebControls.ListBox control.
Use the System.Web.UI.WebControls.ListBox.Rows property to specify the number of rows to display in the System.Web.UI.WebControls.ListBox control.
SelectedIndex
SelectedItem
SelectionMode
ToString
Description
Gets or sets the selection mode of the System.Web.UI.WebControls.ListBox control.
Use the System.Web.UI.WebControls.ListBox.SelectionMode property to specify the mode behavior of the System.Web.UI.WebControls.ListBox control. Setting this property to ListSelectionMode.Single indicates only a single item can be selected from the System.Web.UI.WebControls.ListBox control, while ListSelectionMode.Multiple specifies multiple items can be selected.
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
ToString
Description
Gets or sets the ToolTip text displayed when the mouse pointer rests over the control.
The System.Web.UI.WebControls.ListBox.ToolTip property is inherited from the System.Web.UI.WebControls.WebControl class and is not applicable to the System.Web.UI.WebControls.ListBox control.
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
Adds name, size, multiple, and onchange to list of attributes to render. The output stream that renders HTML content to the client.
OnPreRender
RenderContents
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
ListControl class (System.Web.UI.WebControls)
TrackViewState
Description
Serves as the abstract base class that defines the properties, methods, and events common for all list-type controls.
The System.Web.UI.WebControls.ListControl class is typically not instantiated. Instead, to provide common basic functionality, this class is inherited by others, such as the System.Web.UI.WebControls.CheckBoxList, System.Web.UI.WebControls.DropDownList, System.Web.UI.WebControls.ListBox, and System.Web.UI.WebControls.RadioButtonList.
ListControl
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.ListControl class.
AccessKey
Attributes
AutoPostBack
TrackViewState
Description Gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the list selection.
Set this property to true if the server needs to capture the selection as soon as it is made. For example, other controls on the Web page can be automatically filled depending on the user's selection from a list control.
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DataMember
TrackViewState
Description
Gets or sets the specific table in the System.Web.UI.WebControls.ListControl.DataSource to bind to the control.
If the System.Web.UI.WebControls.ListControl.DataSource contains more than one table, use this property to specify the exact table to bind to the control.
DataSource
TrackViewState
Gets or sets the data source that populates the items of the list control.
Use this property to specify a source of data to populate a list control.
DataTextField
TrackViewState
Gets or sets the field of the data source that provides the text content of the list items.
Use this property to specify a field in the System.Web.UI.WebControls.ListControl.DataSource to display as the items of the list in a list control.
DataTextFormatString
TrackViewState
Gets or sets the formatting string used to control how data bound to the list control is displayed.
Use this property to provide a custom display format for the items in the list control.
DataValueField
TrackViewState
Gets or sets the field of the data source that provides the value of each list item.
Use this property to specify the field that contains the value of each item in a list control.
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
Items
TrackViewState
Description
Gets the collection of items in the list control.
Use this property to get the properties of items in the list control. This property can be used to determine the selected items in the list control.
NamingContainer
Page
Parent
SelectedIndex
TrackViewState
Description
Gets or sets the lowest ordinal index of the selected items in the list.
Use this property to determine the index of the currently selected item in the list if the list control allows only one selection. If the list control supports multiple selections, use this property to determine the lowest index of the selected items.
SelectedItem
TrackViewState
Gets the selected item with the lowest index in the list control.
If the list control allows only a single selection, use this property to get the individual properties of the selected item. If the list control allows multiple selections, use this property to get the properties of the lowest indexed item selected from the list control.
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
TrackViewState
Description
Occurs when the selection on the list changes and is posted back to the server.
This event is raised when the selection from the list changes and is posted back to the server.
ClearSelection
Clears out the list selection and sets the System.Web.UI.WebControls.ListItem.Selected property of all items to false.
LoadViewState
Load previously saved state. Overridden to restore selection.
OnDataBinding
OnSelectedIndexChanged
Raises the System.Web.UI.WebControls.ListControl.SelectedIndexChanged event.
Raising an event invokes the event handler through a delegate. For more information, see. An System.EventArgs that contains the event data.
SaveViewState
TrackViewState
ListItem class (System.Web.UI.WebControls)
TrackViewState
Description
Represents a data item in a databound list control. This class cannot be inherited.
A System.Web.UI.WebControls.ListItem control represents an individual data item within a databound list control, such as a System.Web.UI.WebControls.ListBox or a System.Web.UI.WebControls.RadioButtonList control.
ListItem
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.ListItem class.
ListItem
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.ListItem class with the specified text data. The text data to initialize the list item with.
ListItem
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.ListItem class with the specified text and value data.
The following table shows initial property values for an instance of System.Web.UI.WebControls.ListItem. The text data to initialize the list item with. The value data to initialize the list item with.
Attributes
TrackViewState
Gets the collection of attribute name/value pairs expressed on the list item control but not supported by the control's strongly typed properties.
Selected
TrackViewState
Specifies a value indicating whether the item is selected.
Text
TrackViewState
Gets or sets the text displayed in the list control for the item represented by the System.Web.UI.WebControls.ListItem control.
If the list item control has no text content, then gets its value content, if exists, instead.
Value
TrackViewState
Gets or sets the value content of the list item control.
If the list item control has no value content, then gets its text content, if exists, instead.
Equals
FromString
Creates a System.Web.UI.WebControls.ListItem from the specified string. The specified string for creating a System.Web.UI.WebControls.ListItem.
GetHashCode
IAttributeAccessor. GetAttribute
IAttributeAccessor. SetAttribute
IParserAccessor.AddParsedSubObject
IStateManager.LoadViewState
IStateManager.SaveViewState
IStateManager.TrackViewState
ToString
ListItemCollection class (System.Web.UI.WebControls)
ToString
Description
Encapsulates the System.Web.UI.WebControls.ListItem controls within a System.Web.UI.WebControls.ListControl. This class cannot be inherited.
ListItemCollection
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.ListItemCollection class.
Capacity
ToString
Count
ToString
Gets the item count of the collection.
IsReadOnly
ToString
Gets a value indicating whether the collection is read-only.
IsSynchronized
ToString
Gets a value indicating whether access to the collection is synchronized (thread-safe).
Item
ToString
Gets a System.Web.UI.WebControls.ListItem referenced by the specified ordinal index value. An ordinal index value that specifies which System.Web.UI.WebControls.ListItem to return.
SyncRoot
ToString
Gets the object that can be used to synchronize access to the collection. In this case, it is the collection itself.
Add
Adds the specified System.Web.UI.WebControls.ListItem to the end of the collection. The System.Web.UI.WebControls.ListItem to add to the collection.
Add
Adds the specified item to the end of the collection. A System.String that specifies the item to add.
AddRange
Clear
Removes all System.Web.UI.WebControls.ListItem controls from the collection.
Contains
Returns a value indicating whether the collection contains the specified item.
Return Value: true if the collection contains the specified item; otherwise, false. A System.Web.UI.WebControls.ListItem to search for in the collection.
CopyTo
Copies contents from the collection to a specified System.Array with a specified starting index. The specified System.Array that receives copied contents from the collection. The starting position in the specified System.Array to receive copied contents.
FindByText
FindByValue
GetEnumerator
Returns an enumerator of all System.Web.UI.WebControls.ListItem controls within the collection.
Return Value: An enumerator that enumerates over all System.Web.UI.WebControls.ListItem controls within the collection.
IndexOf
Returns an ordinal index value that represents the position of the specified System.Web.UI.WebControls.ListItem within the collection.
Return Value: The ordinal index position of the specified System.Web.UI.WebControls.ListItem within the collection. The specified System.Web.UI.WebControls.ListItem to search for in the collection.
Insert
Inserts the specified System.Web.UI.WebControls.ListItem to the collection at the specified index location. The location in the collection to add the System.Web.UI.WebControls.ListItem. The System.Web.UI.WebControls.ListItem to add to the collection.
Insert
Adds the specified item to the collection at the specified index location. The location in the collection to add the System.Web.UI.WebControls.ListItem. The item to add to the collection.
Remove
Removes the specified System.Web.UI.WebControls.ListItem from the collection. The System.Web.UI.WebControls.ListItem to remove from the collection.
Remove
Removes the specified item from the collection. The item to remove from the collection.
RemoveAt
Removes the System.Web.UI.WebControls.ListItem from the collection at the specified index location. The location in the collection to remove the System.Web.UI.WebControls.ListItem.
IList.Add
IList.Contains
IList.IndexOf
IList.Insert
IList.Remove
IStateManager.LoadViewState
IStateManager.SaveViewState
IStateManager.TrackViewState
ListItemControlBuilder class (System.Web.UI.WebControls)
ToString
Description
Interacts with the parser to build a System.Web.UI.WebControls.ListItem control.
ListItemControlBuilder
Example Syntax:
ToString
ControlType
FChildrenAsProperties
FIsNonParserAccessor
HasAspCode
ID
InDesigner
NamingContainerType
Parser
TagName
AllowWhitespaceLiterals
HtmlDecodeLiterals
ListItemType enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the type of an item in a list control.
The System.Web.UI.WebControls.ListItemType enumeration represents the different items that can be included in a list control, such as System.Web.UI.WebControls.DataGrid, System.Web.UI.WebControls.DataList, and the System.Web.UI.WebControls.Repeater. A typical list control consists of cells that contain elements represented by this enumeration.
ToString
An item in alternating (zero-based even-indexed) cells. It is databound.
ToString
An item in a list control currently in edit mode. It is databound.
ToString
A tooter for the list control. It is not databound.
ToString
A header for the list control. It is not databound.
ToString
ToString
A pager that displays the controls to navigate to different pages associated with the System.Web.UI.WebControls.DataGrid control. It is not databound.
ToString
A selected item in the list control. It is databound.
ToString
A separator between items in a list control. It is not databound.
ListSelectionMode enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the selection mode of the System.Web.UI.WebControls.ListBox control.
The System.Web.UI.WebControls.ListSelectionMode enumeration represents the selection mode of the System.Web.UI.WebControls.ListBox control that determines whether a user can select multiple items or just a single item.
ToString
Multiple item selection mode.
ToString
Single item selection mode.
Literal class (System.Web.UI.WebControls)
ToString
Description
Literal
Example Syntax:
ToString
ChildControlsCreated
ClientID
Context
Controls
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
TemplateSourceDirectory
Text
ToString
UniqueID
ViewState
ViewStateIgnoresCase
Visible
AddParsedSubObject
CreateControlCollection
Render
LiteralControlBuilder class (System.Web.UI.WebControls)
TrackViewState
LiteralControlBuilder
Example Syntax:
TrackViewState
ControlType
FChildrenAsProperties
FIsNonParserAccessor
HasAspCode
ID
InDesigner
NamingContainerType
Parser
TagName
AllowWhitespaceLiterals
AppendSubBuilder
MonthChangedEventArgs class (System.Web.UI.WebControls)
ToString
Description
Provides data for the System.Web.UI.WebControls.Calendar.VisibleMonthChanged event of a System.Web.UI.WebControls.Calendar. This class cannot be inherited.
The System.Web.UI.WebControls.Calendar.VisibleMonthChanged event is raised when the user clicks on the System.Web.UI.WebControls.Calendar navigation controls to display the next or previous month.
MonthChangedEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.MonthChangedEventArgs class.
The following table shows initial property values for an instance of System.Web.UI.WebControls.MonthChangedEventArgs. The date that determines the month currently displayed by the System.Web.UI.WebControls.Calendar. The date that determines the month previously displayed by the System.Web.UI.WebControls.Calendar.
NewDate
ToString
Gets the date that determines the currently displayed month in the System.Web.UI.WebControls.Calendar.
Use this property to get the month currently displayed by the System.Web.UI.WebControls.Calendar and to compare the currently displayed month with another month. For example, you can use this property to calculate the number of months until or since a certain date.
PreviousDate
ToString
Gets the date that determined the previously displayed month in the System.Web.UI.WebControls.Calendar.
Use this property to determine the previously displayed month on the System.Web.UI.WebControls.Calendar. This date can be used to restore the System.Web.UI.WebControls.Calendar back to the previously displayed month by setting the System.Web.UI.WebControls.Calendar.VisibleDate property to System.Web.UI.WebControls.MonthChangedEventArgs.PreviousDate.
MonthChangedEventHandler delegate (System.Web.UI.WebControls)
ToString
Description Represents the method that handles the System.Web.UI.WebControls.Calendar.VisibleMonthChanged event of a System.Web.UI.WebControls.Calendar. The source of the event. A System.Web.UI.WebControls.MonthChangedEventArgs that contains the event data.
The System.Web.UI.WebControls.Calendar.VisibleMonthChanged event is raised when the user clicks on the navigation controls for the System.Web.UI.WebControls.Calendar to display the next or previous month.
NextPrevFormat enumeration (System.Web.UI.WebControls)
ToString
Description
Represents the display format for the previous and next month navigation controls within the System.Web.UI.WebControls.Calendar.
The System.Web.UI.WebControls.NextPrevFormat enumeration represents the different styles for the next and previous month buttons on the System.Web.UI.WebControls.Calendar.
ToString
Custom text format for the month navigation controls on the System.Web.UI.WebControls.Calendar.
ToString
Full month name format for the month navigation controls on the System.Web.UI.WebControls.Calendar. For example, “January”.
ToString
Abbreviated month name format for the month navigation controls on the System.Web.UI.WebControls.Calendar. For example, “Jan”.
PagedDataSource class (System.Web.UI.WebControls)
ToString
Description
Provides a wrapper over an System.Collections.ICollection data source to implement paging semantics or ‘paged views’ on top of the underlying datasource. This class cannot be inherited.
This class uses the best available interface to enumerate over the data belonging to the current page. If the underlying data source supports indexed access (like System.Array and System.Collections.IList ), this wrapper uses it. Otherwise it falls back on System.Collections.IEnumerable.
PagedDataSource
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.PagedDataSource class.
The following table shows initial property values for an instance of System.Web.UI.WebControls.PagedDataSource.
AllowCustomPaging
ToString
Gets or sets a value indicating whether to assume the underlying data source contains data for just the current page.
This is only applicable if AllowPaging is true. In this scenario, the developer can fetch just the right number of items from the DataSet to fill up a single page, which may be more efficient based on the source of the data.
AllowPaging
ToString
Gets or sets a value indicating whether to implement page semantics on top of the underlying datasource.
Count
ToString
Gets the number of items to be used from the datasource.
This takes into account several factors such as paged/non-paged modes, custom paging, and last page.
CurrentPageIndex
ToString
Gets or sets a value indicating the index of the current page.
DataSource
ToString
Gets or sets the data source.
DataSourceCount
ToString
Gets the item count of the data source.
FirstIndexInPage
ToString
Gets the first index in the page.
IsCustomPagingEnabled
ToString
Gets a value indicating whether custom paging is enabled.
IsFirstPage
ToString
Gets a value indicating if the current page is the first page.
IsLastPage
ToString
Gets a value indicating if the current page is the last page.
IsPagingEnabled
ToString
Gets a value indicating whether paging is enabled.
IsReadOnly
ToString
Gets a value indicating whether the data source is read-only.
IsSynchronized
ToString
Gets a value indicating whether access to the data source is synchronized (thread-safe).
PageCount
ToString
Gets the page count.
PageSize
ToString
Gets or sets the page size.
SyncRoot
ToString
Gets the object that can be used to synchronize access to the collection. In this case, it is the collection itself.
VirtualCount
ToString
Gets or sets the virtual count.
CopyTo
Copies contents from the data source to the specified System.Array with the specified starting index. The specified System.Array that receives copied contents from the data source. The starting position in the specified System.Array to receive copied contents.
GetEnumerator
Returns an enumerator of all items within the data source.
Return Value: An enumerator that enumerates over all items within the data source.
GetItemProperties
GetListName
PagerMode enumeration (System.Web.UI.WebControls)
ToString
Description
Represents the mode of the pager for accessing various pages within the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.PagerMode enumeration represents the different display modes for the pager of a System.Web.UI.WebControls.DataGrid control.
ToString
A pager with Previous and Next buttons to access the next and previous pages.
ToString
A pager with numbered buttons to access pages directly.
PagerPosition enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the position of the pager for accessing various pages within the System.Web.UI.WebControls.DataGrid control.
The System.Web.UI.WebControls.PagerPosition enumeration represents the different locations where the pager can be displayed.
ToString
A pager positioned at the bottom of the System.Web.UI.WebControls.DataGrid.
ToString
A pager positioned at the top of the System.Web.UI.WebControls.DataGrid.
ToString
Pagers positioned at both the top and the bottom of the System.Web.UI.WebControls.DataGrid.
Panel class (System.Web.UI.WebControls)
ToString
Description
Represents a control that acts as a container for other controls.
The System.Web.UI.WebControls.Panel control is a container for other controls. It is especially useful when you want to generate controls programmatically or hide/show a group of controls.
Panel
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Panel class.
AccessKey
Attributes
BackColor
BackImageUrl
ToString
Description
Gets or sets the URL of the background image for the panel control.
Use this property to display a custom image for the System.Web.UI.WebControls.Panel control.
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
HorizontalAlign
ToString
Description
Gets or sets the horizontal alignment of the contents within the panel.
Use this property to specify the alignment of the elements in the System.Web.UI.WebControls.Panel.
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
Wrap
ToString
Description
Gets or sets a value indicating whether the content wraps within the panel.
Use this property to wrap the contents of the System.Web.UI.WebControls.Panel.
AddAttributesToRender
Add background-image to list of style attributes to render. Add align and nowrap to list of attributes to render.
PlaceHolder class (System.Web.UI.WebControls)
TrackViewState
Description
A container to store dynamically added server controls on the Web page.
Use the System.Web.UI.WebControls.PlaceHolder control as a container to store dynamically added server controls to the Web page. The System.Web.UI.WebControls.PlaceHolder control does not produce any visible output and is only used as a container for other controls on the Web page. You can use the System.Web.UI.Control.Controls collection to add, insert, or remove a control from the System.Web.UI.WebControls.PlaceHolder control.
PlaceHolder
Example Syntax:
TrackViewState
ChildControlsCreated
ClientID
Context
Controls
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
Visible
PlaceHolderControlBuilder class (System.Web.UI.WebControls)
TrackViewState
System.Web.UI.WebControls.PlaceHolder
PlaceHolderControlBuilder
Example Syntax:
TrackViewState
ControlType
FChildrenAsProperties
FIsNonParserAccessor
HasAspCode
ID
InDesigner
NamingContainerType
Parser
TagName
AllowWhitespaceLiterals
RadioButton class (System.Web.UI.WebControls)
ToString
Description
Represents a radio button control.
The System.Web.UI.WebControls.RadioButton server control permits you to intersperse the radio buttons in a group with other content in the page. The buttons are grouped logically because they all share the same System.Web.UI.WebControls.RadioButton.GroupName.
RadioButton
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.RadioButton class.
AccessKey
Attributes
AutoPostBack
BackColor
BorderColor
BorderStyle
BorderWidth
Checked
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
GroupName
ToString
Description
Gets or sets the name of the group that the radio button belongs to.
Use this property to specify a grouping of radio buttons to create a mutually exclusive set of controls. The property can be used when only one selection is possible from a list of available options, as in the case of gender.
HasChildViewState
Height
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
TextAlign
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
OnPreRender
This method is invoked just prior to rendering. Register client script for handling postback if onChangeHandler is set.
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
RadioButtonList class (System.Web.UI.WebControls)
TrackViewState
Description
Represents a list control that encapsulates a group of radio button controls.
The System.Web.UI.WebControls.RadioButtonList control provides page developers with a single-selection radio button group that can be dynamically generated via data binding. It contains an System.Web.UI.WebControls.ListControl.Items collection with members that correspond to individual items on the list. To determine which item is selected, test the System.Web.UI.WebControls.ListControl.SelectedItem property of the list.
RadioButtonList
Example Syntax:
TrackViewState
Initializes a new instance of a System.Web.UI.WebControls.RadioButtonList class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.RadioButtonList class.
AccessKey
Attributes
AutoPostBack
BackColor
BorderColor
BorderStyle
BorderWidth
CellPadding
TrackViewState
Description
Gets or sets the distance (in pixels) between the border and the contents of the table cell.
This property only applies when the System.Web.UI.WebControls.RadioButtonList.RepeatLayout property is set to RepeatLayout.Table.
CellSpacing
TrackViewState
Gets or sets the distance (in pixels) between adjacent table cells.
This property only applies when the System.Web.UI.WebControls.RadioButtonList.RepeatLayout property is set to RepeatLayout.Table.
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DataMember
DataSource
DataTextField
DataTextFormatString
DataValueField
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
Items
NamingContainer
Page
Parent
RepeatColumns
TrackViewState
Description
Gets or sets the number of columns to display in the System.Web.UI.WebControls.RadioButtonList control.
Use this property to specify the number of columns that display items in the System.Web.UI.WebControls.RadioButtonList control. If this property is not set, the System.Web.UI.WebControls.RadioButtonList control will display all items in the list in a single column.
RepeatDirection
TrackViewState
Gets or sets the direction that the radio buttons within the group are displayed.
Use this property to specify the display direction of the System.Web.UI.WebControls.RadioButtonList control.
RepeatLayout
TrackViewState
Gets or sets the layout of radio buttons within the group.
Use this property to specify whether the items in the System.Web.UI.WebControls.RadioButtonList control are displayed in a table. If this property is set to RepeatLayout.Table, the items in the list are displayed in a table. If this property is set to RepeatLayout.Flow, the items in the list are displayed without a table structure.
SelectedIndex
SelectedItem
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
TextAlign
TrackViewState
Description
Gets or sets the text alignment for the radio buttons within the group.
Use this property to specify whether the text associated with the radio buttons appears on the left or right. If this property is set to TextAlign.Right, the text is displayed to the right of the radio button. If this property is set to TextAlign.Left, the text is displayed to the left of the radio button.
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
CreateControlStyle
Render
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
IRepeatlnfoUser.GetItemStyle
IRepeatInfoUser.RenderItem
RangeValidator class (System.Web.UI.WebControls)
TrackViewState
Description
Checks whether the value of an input control is within a specified range of values.
The System.Web.UI.WebControls.RangeValidator control tests whether the value of an input control is within a specified range.
RangeValidator
Example Syntax:
TrackViewState
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
ControlToValidate
CssClass
Display
EnableClientScript
Enabled
EnableViewState
ErrorMessage
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
IsValid
MaximumValue
TrackViewState
Description
Gets or sets the maximum value of the validation range.
Use the System.Web.UI.WebControls.RangeValidator.Maximumvalue property to specify the maximum value of the validation range. If the value specified by this property fails to convert to the data type specified by the System.Web.UI.WebControls.BaseCompareValidator.Type property, an exception is thrown.
MinimumValue
TrackViewState
Gets or sets the minimum value of the validation range.
Use the System.Web.UI.WebControls.RangeValidator.MinimumValue property to specify the minimum value of the validation range. If the value specified by this property fails to convert to the data type specified by the System.Web.UI.WebControls.BaseCompareValidator.Type property, a trace debug message is generated, the System.Web.UI.WebControls.BaseValidator.IsValid property is set to true, and no additional processing is performed.
NamingContainer
Page
Parent
PropertiesValid
RenderUplevel
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToolTip
Type
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
AddAttributesToRender method AddAttributesToRender method
ControlPropertiesValid
This is a check of properties to determine any errors made by the developer This is a check of properties to determine any errors made by the developer
EvaluateIsValid
EvaluateIsValid method EvaluateIsValid method
RegularExpressionValidator class (System.Web.UI.WebControls)
Validate
Description
Validates whether the value of an associated input control matches the pattern specified by a regular expression.
The System.Web.UI.WebControls.RegularExpressionValidator control checks whether the value of an input control matches a pattern defined by a regular expression. This type of validation allows you to check for predictable sequences of characters, such as those in social security numbers, e-mail addresses, telephone numbers, and postal codes.
RegularExpressionValidator
Example Syntax:
Validate
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
ControlToValidate
CssClass
Display
EnableClientScript
Enabled
EnableViewState
ErrorMessage
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
IsValid
NamingContainer
Page
Parent
PropertiesValid
RenderUplevel
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToolTip
UniqueID
ValidationExpression
Validate
Description
Gets or sets the regular expression that determines the pattern used to validate a field.
Use this property to specify the pattern used to check for predictable sequences of characters, such as those in social security numbers, e-mail addresses, telephone numbers, and postal codes.
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
AddAttributesToRender method AddAttributesToRender method
EvaluateIsValid
EvaluateIsValid method EvaluateIsValid method
RepeatDirection enumeration (System.Web.UI.WebControls)
Validate
Description
Specifies the direction in which items of a list control are displayed.
The System.Web.UI.WebControls.RepeatDirection enumeration represents the different directions in which the items of a list control can be displayed.
Validate
Items of a list are displayed horizontally in rows from left to right, then top to bottom, until all items are rendered.
Validate
Items of a list are displayed vertically in columns from top to bottom, and then left to right, until all items are rendered.
Repeater class (System.Web.UI.WebControls)
ToString
Description
A databound list control that allows custom layout by repeating a specified template for each item displayed in the list.
The System.Web.UI.WebControls.Repeater is a basic templated databound list. It has no built-in layout or styles, so you must explicitly declare all HTML layout, formatting, and style tags within the control's templates.
Repeater
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Repeater class.
AlternatingItemTemplate
ToString
Gets or sets the System.Web.UI.ITemplate that defines how alternating (zero-based odd-indexed) items are rendered.
Use this property to provide a different appearance from the System.Web.UI.WebControls.Repeater.ItemTemplate for alternating items in the System.Web.UI.WebControls.Repeater.
ChildControlsCreated
ClientID
Context
Controls
ToString
DataMember
ToString
Description
Gets or sets the specific table in the System.Web.UI.WebControls.Repeater.DataSource to bind to the control.
If the System.Web.UI.WebControls.Repeater.DataSource contains multiple tables, use this property to specify the table to bind to the System.Web.UI.WebControls.Repeater.
DataSource
ToString
Gets or sets the data source that provides data for populating the list.
Use this property to specify the source of data to populate the System.Web.UI.WebControls.Repeater control. The System.Web.UI.WebControls.Repeater.DataSource can be any System.Collections.IEnumerable derived object such as a System.Data.DataView for accessing databases, an System.Collections.ArrayList, a System.Collections.Hashtable, or an array.
EnableViewState
Events
FooterTemplate
ToString
Description
Gets or sets the System.Web.UI.ITemplate that defines how the control footer is rendered.
Use this property to create a template that controls how the tooter of a System.Web.UI.WebControls.Repeater control is displayed.
HasChildViewState
HeaderTemplate
ToString
Description
Gets or sets the System.Web.UI.ITemplate that defines how the control header is rendered.
Use this property to create a template that controls how the header of a System.Web.UI.WebControls.Repeater control is displayed.
ID
IsTrackingViewState
Items
ToString
Description
Gets a collection of System.Web.UI.WebControls.RepeaterItem objects in the System.Web.UI.WebControls.Repeater.
The System.Web.UI.WebControls.Repeater populates the System.Web.UI.WebControls.Repeater.Items collection by enumerating every object in its System.Web.UI.WebControls.Repeater.DataSource. The System.Web.UI.WebControls.Repeater.Items collection is then used by the System.Web.UI.WebControls.Repeater to render each item in the control.
ItemTemplate
ToString
Gets or sets the System.Web.UI.ITemplate that defines how items are rendered.
Use this property to create a template that controls how individual items in the System.Web.UI.WebControls.Repeater are displayed.
NamingContainer
Page
Parent
SeparatorTemplate
ToString
Description
Gets or sets the System.Web.UI.ITemplate that defines how separators between items are rendered.
Use this property to create a template that controls how separators between items are displayed.
Site
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
Visible
ToString
Description
Occurs when a button is clicked in the System.Web.UI.WebControls.Repeater control.
This event is raised when a button in the System.Web.UI.WebControls.Repeater is clicked.
ToString
Occurs when an item is created in the System.Web.UI.WebControls.Repeater control.
This event is raised when an item is created in the System.Web.UI.WebControls.Repeater.
ToString
Occurs after an item in the System.Web.UI.WebControls.Repeater is databound but before it is rendered on the page.
This event is raised when an item in the System.Web.UI.WebControls.Repeater is databound.
CreateChildControls
CreateControlHierarchy
A protected method. Creates a control hierarchy, with or without the data source as specified. Indicates whether to use the data source or not.
CreateItem
A protected method. Creates a System.Web.UI.WebControls.RepeaterItem with the specified item type and location within the System.Web.UI.WebControls.Repeater. The specified location within the System.Web.UI.WebControls.Repeater to place the created item. A System.Web.UI.WebControls.ListItemType that represents the specified type of the System.Web.UI.WebControls.Repeater item to create.
DataBind
InitializeItem
A protected method. Populates iteratively the specified System.Web.UI.WebControls.RepeaterItem with a sub-hierarchy of child controls. The control to be initialized from an inline template.
OnBubbleEvent
OnDataBinding
A protected method. Raises the DataBinding event.
OnItemCommand
Raises the System.Web.UI.WebControls.Repeater.ItemCommand event.
Raising an event invokes the event handler through a delegate. For more information, see. The System.Web.UI.WebControls.RepeaterCommandEventArgs that contains the event data.
OnItemCreated
Raises the System.Web.UI.WebControls.Repeater.ItemCreated event.
Raising an event invokes the event handler through a delegate. For more information, see. The System.Web.UI.WebControls.RepeaterItemEventArgs that contains the event data.
OnItemDataBound
Raises the System.Web.UI.WebControls.Repeater.ItemDataBound event.
Raising an event invokes the event handler through a delegate. For more information, see. The System.Web.UI.WebControls.RepeaterItemEventArgs that contains the event data.
RepeaterCommandEventArgs class (System.Web.UI.WebControls)
TrackViewState
Description
Provides data for the System.Web.UI.WebControls.Repeater.ItemCommand event of a System.Web.UI.WebControls.Repeater. This class cannot be inherited.
For a list of initial property values for an instance of System.Web.UI.WebControls.RepeaterCommandEventArgs, see the System.Web.UI.WebControls.RepeaterCommandEventArgs.#ctor constructor. For more information about handling events, see.
RepeaterCommandEventArgs
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.RepeaterCommandEventArgs class.
The following table shows initial property values for an instance of System.Web.UI.WebControls.RepeaterCommandEventArgs. A System.Web.UI.WebControls.RepeaterItem that represents an item in the System.Web.UI.WebControls.Repeater. The System.Web.UI.WebControls.RepeaterCommandEventArgs.Item property is set to this value. The command source. The System.Web.UI.WebControls.RepeaterCommandEventArgs.CommandSource property is set to this value. The original event arguments.
CommandArgument
CommandName
CommandSource
TrackViewState
Description
Gets the source of the command.
Use this property to determine the source of the command.
Item
TrackViewState
Gets the System.Web.UI.WebControls.RepeaterItem associated with the event.
Use this property to access the properties of the System.Web.UI.WebControls.RepeaterItem associated with this event.
RepeaterCommandEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.Repeater.ItemCommand event of a System.Web.UI.WebControls.Repeater. The source of the event. A System.Web.UI.WebControls.RepeaterCommandEventArgs that contains the event data.
When you create a System.Web.UI.WebControls.RepeaterCommandEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see.
RepeaterItem class (System.Web.UI.WebControls)
ToString
Description
Represents an item in the System.Web.UI.WebControls.Repeater control.
A System.Web.UI.WebControls.RepeaterItem object represents an item in the System.Web.UI.WebControls.Repeater control, such as the heading section, footer section, or a data item.
RepeaterItem
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.RepeaterItem class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.RepeaterItem class. The index of the item in the System.Web.UI.WebControls.Repeater control from the System.Web.UI.WebControls.Repeater.Items collection of the control. One of the System.Web.UI.WebControls.ListItemType values.
ChildControlsCreated
ClientID
Context
Controls
DataItem
ToString
Description
Gets or sets a data item associated with the System.Web.UI.WebControls.RepeaterItem object in the System.Web.UI.WebControls.Repeater control.
Use the System.Web.UI.WebControls.RepeaterItem.DataItem property to specify or determine the properties of a data item associated with the System.Web.UI.WebControls.RepeaterItem object in the System.Web.UI.WebControls.Repeater control.
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
ItemIndex
ToString
Description
Gets the index of the item in the System.Web.UI.WebControls.Repeater control from the System.Web.UI.WebControls.Repeater.Items collection of the control.
Use the System.Web.UI.WebControls.RepeaterItem.ItemIndex property to determine the index number of the item in the System.Web.UI.WebControls.Repeater control from the System.Web.UI.WebControls.Repeater.Items collection of the control.
ItemType
ToString
Gets the type of the item in the System.Web.UI.WebControls.Repeater control.
Use the System.Web.UI.WebControls.RepeaterItem.ItemType property to determine the type of an item in the System.Web.UI.WebControls.Repeater control. The following table lists the different item types.
NamingContainer
Page
Parent
Site
TemplateSourceDirectory
UniqueID
ViewState
ViewStateIgnoresCase
Visible
OnBubbleEvent
RepeaterItemCollection class (System.Web.UI.WebControls)
TrackViewState
Description
Represents a collection of System.Web.UI.WebControls.RepeaterItem objects in the System.Web.UI.WebControls.Repeater control. This class cannot be inherited.
The System.Web.UI.WebControls.RepeaterItemCollection class represents a collection of System.Web.UI.WebControls.RepeaterItem objects, which in turn represent the data items in a System.Web.UI.WebControls.Repeater control. To programmatically retrieve System.Web.UI.WebControls.RepeaterItem objects from a System.Web.UI.WebControls.Repeater control, use one of the following methods: Use the indexer to get a single System.Web.UI.WebControls.RepeaterItem object from the collection using array notation.
RepeaterItemCollection
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.RepeaterItemCollection class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.RepeaterItemCollection class. A System.Collections.ArrayList object that contains the items with which to initialize the collection.
Count
TrackViewState
Gets the number of System.Web.UI.WebControls.RepeaterItem objects in the collection.
Use the System.Web.UI.WebControls.RepeaterItemCollection.Count property to determine the number of System.Web.UI.WebControls.RepeaterItem objects in the System.Web.UI.WebControls.RepeaterItemCollection collection. The System.Web.UI.WebControls.RepeaterItemCollection.Count property is commonly used when iterating through the collection to determine the upper bound of the collection.
IsReadOnly
TrackViewState
Gets a value that indicates whether the System.Web.UI.WebControls.RepeaterItem objects in the System.Web.UI.WebControls.RepeaterItemCollection can be modified.
This property always returns false to indicate that the System.Web.UI.WebControls.RepeaterItemCollection can be written to in all cases.
IsSynchronized
TrackViewState
Gets a value indicating whether access to the System.Web.UI.WebControls.RepeaterItemCollection is synchronized (thread-safe).
This property is derived from the System.Collections.ICollection class and is overridden to always return false.
Item
TrackViewState
Gets the System.Web.UI.WebControls.RepeaterItem object at the specified index in the collection.
Use this indexer to get a System.Web.UI.WebControls.RepeaterItem object from the System.Web.UI.WebControls.RepeaterItemCollection at the specified index, using array notation. The zero-based index of the System.Web.UI.WebControls.RepeaterItem object to retrieve in the collection.
SyncRoot
TrackViewState
Gets the object that can be used to synchronize access to the System.Web.UI.WebControls.RepeaterItemCollection collection.
The object returned in this implementation is the System.Web.UI.WebControls.RepeaterItemCollection object itself.
CopyTo
Copies all the items from this System.Web.UI.WebControls.RepeaterItemCollection to the specified System.Array object, starting at the specified index in the System.Array object.
Use this method to copy the contents of the System.Web.UI.WebControls.RepeaterItemCollection into the specified System.Array object, starting at the specified index. A zero-based System.Array object that receives the copied items from the System.Web.UI.WebControls.RepeaterItemCollection. The first position in the specified System.Array object to receive the copied contents.
GetEnumerator
Returns a System.Collections.IEnumerator interface that contains all System.Web.UI.WebControls.RepeaterItem objects in the System.Web.UI.WebControls.RepeaterItemCollection.
Return Value: A System.Collections.IEnumerator interface that contains all System.Web.UI.WebControls.RepeaterItem objects in the System.Web.UI.WebControls.RepeaterItemCollection.
Use this method to create a System.Collections.IEnumerator that can be easily iterated through to get each item in the System.Web.UI.WebControls.RepeaterItemCollection.
RepeaterItemEventArgs class (System.Web.UI.WebControls)
ToString
Description
Provides data for the System.Web.UI.WebControls.Repeater.ItemCreated and System.Web.UI.WebControls.Repeater.ItemDataBound events of a System.Web.UI.WebControls.Repeater.
For a list of initial property values for an instance of System.Web.UI.WebControls.RepeaterItemEventArgs, see the System.Web.UI.WebControls.RepeaterItemEventArgs.#ctor constructor.
RepeaterItemEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.RepeaterItemEventArgs class.
The following table shows initial property values for an instance of System.Web.UI.WebControls.RepeaterItemEventArgs. The System.Web.UI.WebControls.RepeaterItem associated with the event. The System.Web.UI.WebControls.RepeaterItemEventArgs.Item property is set to this value.
Item
ToString
Gets the System.Web.UI.WebControls.RepeaterItem associated with the event.
Use this property to access the properties of the System.Web.UI.WebControls.RepeaterItem associated with this event.
RepeaterItemEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.Repeater.ItemCreated and System.Web.UI.WebControls.Repeater.ItemDataBound events of a System.Web.UI.WebControls.Repeater. The source of the event. A System.Web.UI.WebControls.RepeaterItemEventArgs that contains the event data.
When you create a System.Web.UI.WebControls.RepeaterItemEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see.
RepeatInfo class (System.Web.UI.WebControls)
ToString
Description
Defines the information used to render a list of items using a System.Web.UI.WebControls.Repeater.
RepeatInfo
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.RepeatInfo class. This class is not inheritable.
OuterTableImplied
ToString
Indicates whether an outer table is implied for the items.
RepeatColumns
ToString
Indicates the column count of items.
RepeatDirection
ToString
Indicates the direction of flow of items.
RepeatLayout
ToString
Indicates the layout of items.
RenderRepeater
Renders the Repeater with the specified information. The output stream that renders HTML content to the client. The control style to copy. The control to copy base attributes from.
RepeatLayout enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the layout of items in a list control.
The System.Web.UI.WebControls.RepeatLayout enumeration represents the different layout options for a list control.
ToString
Items are displayed without a table structure.
ToString
Items are displayed in a table.
RequiredFieldValidator class (System.Web.UI.WebControls)
ToString
Description
Makes the associated input control a required field.
Use this control to make an input control a required field. The input control faills validation if its value does not change from the System.Web.UI.WebControls.RequiredFieldValidator.InitialValue property upon losing focus.
RequiredFieldValidator
Example Syntax:
ToString
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
ControlToValidate
CssClass
Display
EnableClientScript
Enabled
EnableViewState
ErrorMessage
Events
Font
ForeColor
HasChildViewState
Height
ID
InitialValue
ToString
Description
Gets or sets the initial value of the associated input control.
Use this property to specify the initial value of the input control.
IsTrackingViewState
IsValid
NamingContainer
Page
Parent
PropertiesValid
RenderUplevel
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
AddAttributesToRender method AddAttributesToRender method
EvaluateIsValid
EvaluateIsValid method EvaluateIsValid method
Table.RowControlCollection class (System.Web.UI.WebControls)
Validate
Description
Count
IsReadOnly
IsSynchronized
Item
Owner
SyncRoot
Add
Adds the specified System.Web.UI.Control object to the collection. The new control is added to the end of the array.
AddAt
Adds the specified System.Web.UI.Control object to the collection. The new control is added to the array at the specified index location. The location in the array to add the child control. The Control object to add to the collection.
SelectedDatesCollection class (System.Web.UI.WebControls)
ToString
Description
Encapsulates a collection of System.DateTime objects that represent the selected dates in a System.Web.UI.WebControls.Calendar control. This class cannot be inherited.
Use this class to programmatically manage a collection of System.DateTime objects that represent the selected dates in a System.Web.UI.WebControls.Calendar control. This class is commonly used to add or remove dates.
SelectedDatesCollection
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.SelectedDatesCollection class with the specified date list.
Use this constructor to create a new instance of the System.Web.UI.WebControls.SelectedDatesCollection class. A System.Collections.ArrayList that represents a collection of dates.
Count
ToString
Gets the number of System.DateTime objects in the System.Web.UI.WebControls.SelectedDatesCollection.
Use this property to determine the number of dates in the System.Web.UI.WebControls.SelectedDatesCollection. The System.Web.UI.WebControls.SelectedDatesCollection.Count property is often used when iterating through the collection to determine the upper bound.
IsReadOnly
ToString
Gets a value indicating whether the System.Web.UI.WebControls.SelectedDatesCollection is read-only.
This property always returns false to indicate that the System.Web.UI.WebControls.SelectedDatesCollection can be written to in all cases.
IsSynchronized
ToString
Gets a value indicating whether access to the System.Web.UI.WebControls.SelectedDatesCollection is synchronized (thread-safe).
This property is derived from System.Collections.ICollection and is overridden to always return false.
Item
ToString
Gets a System.DateTime at the specified index in the System.Web.UI.WebControls.SelectedDatesCollection.
Use this indexer to get an individual System.DateTime in the System.Web.UI.WebControls.SelectedDatesCollection at the specified index using simple array notation. An ordinal index value that specifies which System.DateTime to return.
SyncRoot
ToString
Gets the object that can be used to synchronize access to the System.Web.UI.WebControls.SelectedDatesCollection.
The object returned in this implementation is the System.Web.UI.WebControls.SelectedDatesCollection object itself.
Add
Appends the specified System.DateTime to the end of the System.Web.UI.WebControls.SelectedDatesCollection.
Use this method to add the specified System.DateTime to the end of the System.Web.UI.WebControls.SelectedDatesCollection. The System.DateTime to add to the collection.
Clear
Removes all System.DateTime controls from the collection.
Use this method to remove all System.DateTime objects from the System.Web.UI.WebControls.SelectedDatesCollection and set the System.Web.UI.WebControls.SelectedDatesCollection.Count property to 0.
Contains
Returns a value indicating whether the System.Web.UI.WebControls.SelectedDatesCollection contains the specified System.DateTime object.
Return Value: true if the System.Web.UI.WebControls.SelectedDatesCollection contains the specified System.DateTime; otherwise, false.
Use this method to determine whether the System.Web.UI.WebControls.SelectedDatesCollection contains the specified System.DateTime. The System.DateTime object to search for in the System.Web.UI.WebControls.SelectedDatesCollection.
CopyTo
Copies the items from the System.Web.UI.WebControls.SelectedDatesCollection to the specified System.Array, starting with the specified index.
Use this method to copy the contents of the System.Web.UI.WebControls.SelectedDatesCollection into the specified System.Array, starting at the specified index. A zero-based System.Array that receives the copied items from the System.Web.UI.WebControls.SelectedDatesCollection. The first index in the specified System.Array to receive the items.
GetEnumerator
Returns a System.Collections.IEnumerator that contains all System.DateTime objects within the System.Web.UI.WebControls.SelectedDatesCollection.
Return Value: A System.Collections.IEnumerator that contains all System.DateTime objects within the System.Web.UI.WebControls.SelectedDatesCollection.
Use this method to create a System.Collections.IEnumerator that can be easily iterated through to get each item in the System.Web.UI.WebControls.SelectedDatesCollection.
Remove
Removes the specified System.DateTime object from the System.Web.UI.WebControls.SelectedDatesCollection.
Use this method to remove the specified System.DateTime from the System.Web.UI.WebControls.SelectedDatesCollection. The System.DateTime object to remove from the System.Web.UI.WebControls.SelectedDatesCollection.
SelectRange
Adds the specified range of dates to the System.Web.UI.WebControls.SelectedDatesCollection.
Use this method to add the specified range of dates to the System.Web.UI.WebControls.SelectedDatesCollection. A System.DateTime object that specifies the initial date to add to the System.Web.UI.WebControls.SelectedDatesCollection. A System.DateTime object that specifies the end date to add to the System.Web.UI.WebControls.SelectedDatesCollection.
ServerValidateEventArgs class (System.Web.UI.WebControls)
ToString
Description
Provides data for the System.Web.UI.WebControls.CustomValidator.ServerValidate event of the System.Web.UI.WebControls.CustomValidator control. This class cannot be inherited.
A System.Web.UI.WebControls.ServerValidateEventArgs object is passed to the System.Web.UI.WebControls.CustomValidator.ServerValidate event handler to provide event data to the handler. The System.Web.UI.WebControls.CustomValidator.ServerValidate event is raised when validation is performed on the server. This allows you to perform a custom server-side validation routine on the value of an input control (with a System.Web.UI.WebControls.CustomValidator control associated with it) in the event handler.
ServerValidateEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.ServerValidateEventArgs class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.ServerValidateEventArgs class. The value to validate. true to indicate that the value passes validation; otherwise, false.
IsValid
ToString
Gets or sets whether the value specified by the System.Web.UI.WebControls.ServerValidateEventArgs.Value property passes validation.
Once your validation routine finishes, use the System.Web.UI.WebControls.ServerValidateEventArgs.IsValid property to indicate whether the value specified by the System.Web.UI.WebControls.ServerValidateEventArgs.Value property passes validation. This value determines whether input control associated with the System.Web.UI.WebControls.CustomValidator control passes validation.
Value
ToString
Gets the value to validate in the custom event handler for the System.Web.UI.WebControls.CustomValidator.ServerValidate event.
Use the System.Web.UI.WebControls.ServerValidateEventArgs.Value property determine the value to validate in the custom event handler for the System.Web.UI.WebControls.CustomValidator.ServerValidate event. Notice that you cannot programmatically change this value.
ServerValidateEventHandler delegate (System.Web.UI.WebControls)
ToString
Description
Represents the method that will handle the System.Web.UI.WebControls.CustomValidator.ServerValidate event of a System.Web.UI.WebControls.CustomValidator control. The source of the event. A System.Web.UI.WebControls.ServerValidateEventArgs that contains the event data.
Use this delegate to provide custom code that performs validation on the server. Your code needs to validate the System.Web.UI.WebControls.ServerValidateEventArgs.Value property of the args parameter passed to the delegate. Store the result of the validation in the System.Web.UI.WebControls.ServerValidateEventArgs.IsValid property of the args parameter.
Style class (System.Web.UI.WebControls)
ToString
Description
Represents attributes that define the style of a Web Forms control and provides methods to manage the style.
Style
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Style class.
Style
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Style class with the specified state bag information. Contains the specified state bag information.
BackColor
ToString
Gets or sets the background color property of the System.Web.UI.WebControls.Style class.
BorderColor
ToString
Gets or sets the border color property of the System.Web.UI.WebControls.Style class.
BorderStyle
ToString
Gets or sets the border style property of the System.Web.UI.WebControls.Style class.
BorderWidth
ToString
Gets or sets the border width property of the System.Web.UI.WebControls.Style class.
Container
CssClass
ToString
Description
Gets or sets the CSS class property of the System.Web.UI.WebControls.Style class.
DesignMode
Events
Font
ToString
Description
Gets a System.Web.UI.WebControls.FontInfo object that contains the font properties for the System.Web.UI.WebControls.Style class.
ForeColor
ToString
Gets or sets the foreground color (typically the color of the text) property of the System.Web.UI.WebControls.Style class.
Height
ToString
Gets or sets the height property of the System.Web.UI.WebControls.Style class.
IsEmpty
ToString
A protected property. Gets a value indicating whether any style elements have been defined in the state bag.
IsTrackingViewState
ToString
A protected method. Returns a value indicating whether any style elements have been defined in the state bag.
Return Value: true if there are style elements defined in the state bag; otherwise, false.
Site
ViewState
ToString
Description
Gets the state bag that holds the style elements.
The private field name for the state bag is case sensitive.
Width
ToString
Gets or sets the width property of the System.Web.UI.WebControls.Style class.
AddAttributesToRender
Adds all non-blank style attributes to the HTML output stream to be rendered to the client. The output stream that renders HTML content to the client.
AddAttributesToRender
Adds all non-blank style attributes to the HTML output stream to be rendered to the client.
CopyFrom
Copies non-blank elements from the specified style, overwriting existing style elements if necessary. The style to be copied.
LoadViewState
A protected method. Load the previously saved state. The previously saved state.
MergeWith
Copies non-blank elements from the specified style, but will not overwrite any existing style elements. The style to be copied.
Reset
Clears out any defined style elements from the state bag.
SaveViewState
A protected method. Saves any state that has been modified after the System.Web.UI.WebControls.Style.TrackViewState method was invoked.
Return Value: An object that represents the saved state. The default is null.
SetBit
A protected internal method.
IStateManager.LoadViewState
IStateManager.SaveViewState
IStateManager.TrackViewState
ToString
Overrides the ToString method to return System.String.Empty.
Return Value: System.String.Empty for all cases.
TrackViewState
A protected method. Marks the beginning for tracking state changes on the control. Any changes made after “mark” will be tracked and saved as part of the control viewstate.
Table class (System.Web.UI.WebControls)
TrackViewState
Description
Constructs a table and defines its properties.
The System.Web.UI.WebControls.Table class allows you to build an HTML table and specify its characteristics in a straightforward manner, using the same abstract object model for building any other Web controls. A table can be built at design time given some static contents, but the power of a System.Web.UI.WebControls.Table Web control is often realized when the table is built programmatically with dynamic contents. In addition, as for other Web controls, the same code to render a table yields appropriate output accordingly for both downleveling and upleveling browsers.
Table
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.Table class.
AccessKey
Attributes
BackColor
BackImageUrl
TrackViewState
Description
Indicates the URL of the background image to display behind the table. The image will be tiled if it is smaller than the table.
BorderColor
BorderStyle
BorderWidth
CellPadding
TrackViewState
Description
Gets or sets the distance (in pixels) between the border and the contents of the table cell.
CellSpacing
TrackViewState
Gets or sets the distance (in pixels) between table cells.
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
GridLines
TrackViewState
Description
Gets or sets the gridlines property of the System.Web.UI.WebControls.Table class.
HasChildViewState
Height
HorizontalAlign
TrackViewState
Description
Gets or sets the horizontal alignment of the table within the page.
ID
IsTrackingViewState
NamingContainer
Page
Parent
Rows
TrackViewState
Description
Gets the collection of rows within the table.
This property is only used when building tables programmatically. At design time, the property is set by declaring TableRow Web controls.
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
A protected method. Adds information about the border color and border width HTML attributes to the list of attributes to render. The output stream that renders HTML content to the client.
CreateControlCollection
CreateControlStyle
A protected method. Creates a table control style.
Return Value: A System.Web.UI.WebControls.Style that specifies the table control style.
RenderContents
A protected method. The output stream that renders HTML content to the client.
TableCell class (System.Web.UI.WebControls)
TrackViewState
Description
Represents a cell in a System.Web.UI.WebControls.Table control.
The System.Web.UI.WebControls.TableCell class represents a cell in a System.Web.UI.WebControls.Table control. You can use the System.Web.UI.WebControls.TableCell.Text property to specify or determine the contents of the cell.
TableCell
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.TableCell class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.TableCell class.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
ColumnSpan
TrackViewState
Description
Gets or sets the number of columns in the System.Web.UI.WebControls.Table control that the cell spans.
Use the System.Web.UI.WebControls.TableCell.ColumnSpan property to specify or determine the number of columns in the rendered table that the cell spans. For example, if you set this property to 2 , the cell takes up two columns in the System.Web.UI.WebControls.Table control.
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
HorizontalAlign
TrackViewState
Description
Gets or sets the horizontal alignment of the contents in the cell.
Use the System.Web.UI.WebControls.TableCell.HorizontalAlign property to specify the horizontal alignment of the contents of the cell. The following table lists the possible values.
ID
IsTrackingViewState
NamingContainer
Page
Parent
RowSpan
TrackViewState
Description
Gets or sets the number of rows in the System.Web.UI.WebControls.Table control that the cell spans.
Use the System.Web.UI.WebControls.TableCell.RowSpan property to specify or determine the number of rows in the rendered table that the cell spans. For example, if you set this property to 2 , the cell takes up two rows in the System.Web.UI.WebControls.Table control.
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
TrackViewState
Description
Gets or sets the text contents of the cell.
Use the System.Web.UI.WebControls.TableCell.Text property to specify or determine the text contents of the cell. This property is commonly used to programmatically update the contents of a cell.
ToolTip
UniqueID
VerticalAlign
TrackViewState
Description
Gets or sets the vertical alignment of the contents in the cell.
Use the System.Web.UI.WebControls.TableCell.VerticalAlign property to specify the vertical alignment of the contents of the cell. The following table lists the possible values.
ViewState
ViewStateIgnoresCase
Visible
Width
Wrap
TrackViewState
Description
Gets or sets a value that indicates whether the content of the cell wrap in the cell.
Use the System.Web.UI.WebControls.TableCell.Wrap property to specify or determine whether the content of the cell wrap in the cell.
AddAttributesToRender
A protected method. Adds information about the column span and row span to the list of attributes to render. The output stream that renders HTML content to the client.
AddParsedSubObject
CreateControlStyle
A protected method. Creates a table item control style.
Return Value: A System.Web.UI.WebControls.Style that specifies the table item control style.
RenderContents
A protected method. The output stream that renders HTML content to the client.
TableCellCollection class (System.Web.UI.WebControls)
TrackViewState
Description
Encapsulates a collection of System.Web.UI.WebControls.TableHeaderCell and System.Web.UI.WebControls.TableCell objects that make up a row in a System.Web.UI.WebControls.Table control. This class cannot be inherited.
Use this class to programmatically manage a collection of System.Web.UI.WebControls.TableCell objects that make up a row in a System.Web.UI.WebControls.Table control. This class is commonly used to add or remove cells from a row in a System.Web.UI.WebControls.Table control.
Count
TrackViewState
Gets the number of System.Web.UI.WebControls.TableCell objects in the System.Web.UI.WebControls.TableCellCollection.
Use this property to determine the number of cells in the System.Web.UI.WebControls.TableCellCollection. The System.Web.UI.WebControls.TableCellCollection.Count property is often used when iterating through the collection to determine the upper bound.
IsReadOnly
TrackViewState
Gets a value indicating whether the System.Web.UI.WebControls.TableCellCollection is read-only.
This property always returns false to indicate that the System.Web.UI.WebControls.TableCellCollection can be written to in all cases.
IsSynchronized
TrackViewState
Gets a value indicating whether access to the System.Web.UI.WebControls.TableCellCollection is synchronized (thread-safe).
This property is derived from System.Collections.ICollection and is overridden to always return false.
Item
TrackViewState
Gets a System.Web.UI.WebControls.TableCell from the System.Web.UI.WebControls.TableCellCollection at the specified index.
Use this indexer to get an individual System.Web.UI.WebControls.TableCell in the System.Web.UI.WebControls.TableCellCollection at the specified index using simple array notation. An ordinal index value that specifies the System.Web.UI.WebControls.TableCell to return.
SyncRoot
TrackViewState
Gets the object that can be used to synchronize access to the System.Web.UI.WebControls.TableCellCollection.
The object returned in this implementation is the System.Web.UI.WebControls.TableCellCollection object.
Add
Appends the specified System.Web.UI.WebControls.TableCell to the end of the System.Web.UI.WebControls.TableCellCollection.
Use this method to add the specified System.Web.UI.WebControls.TableCell to the end of a System.Web.UI.WebControls.TableCellCollection. The System.Web.UI.WebControls.TableCell to add to the collection.
AddAt
Adds the specified System.Web.UI.WebControls.TableCell to the System.Web.UI.WebControls.TableCellCollection at the specified index location.
Use this method to insert the specified System.Web.UI.WebControls.TableCell in a System.Web.UI.WebControls.TableCellCollection at the specified index. The location in the System.Web.UI.WebControls.TableCellCollection at which to add the System.Web.UI.WebControls.TableCell. The System.Web.UI.WebControls.TableCell to add to the System.Web.UI.WebControls.TableCellCollection.
AddRange
Clear
Removes all System.Web.UI.WebControls.TableCell objects from the System.Web.UI.WebControls.TableCellCollection.
Use this method to remove all System.Web.UI.WebControls.TableCell objects from the System.Web.UI.WebControls.TableCellCollection and set the System.Web.UI.WebControls.TableCellCollection.Count property to 0.
CopyTo
Copies the items from the System.Web.UI.WebControls.TableCellCollection to the specified System.Array, starting with the specified index in the System.Array.
Use this method to copy the contents of the System.Web.UI.WebControls.TableCellCollection into the specified System.Array starting at the specified index. A zero-based System.Array that receives the copied items from the System.Web.UI.WebControls.TableCellCollection. The first index in the specified System.Array to receive the items.
GetCellIndex
Returns a value that represents the index of the specified System.Web.UI.WebControls.TableCell from the System.Web.UI.WebControls.TableCellCollection.
Return Value: The index of the specified System.Web.UI.WebControls.TableCell within the System.Web.UI.WebControls.TableCellCollection. The default is −1, which indicates that a match has not been found.
Use this method to determine the index of the specified System.Web.UI.WebControls.TableCell in the System.Web.UI.WebControls.TableCellCollection. If the specified System.Web.UI.WebControls.TableCell is not found, an index of −1 is returned. The System.Web.UI.WebControls.TableCell to get the index of in the System.Web.UI.WebControls.TableCellCollection.
GetEnumerator
Returns a System.Collections.IEnumerator that contains all System.Web.UI.WebControls.TableCell objects in the System.Web.UI.WebControls.TableCellCollection.
Return Value: A System.Collections.IEnumerator that contains all System.Web.UI.WebControls.TableCell objects within the System.Web.UI.WebControls.TableCellCollection.
Use this method to create a System.Collections.IEnumerator that can be iterated through easily to get each item in the System.Web.UI.WebControls.TableCellCollection.
Remove
Removes the specified System.Web.UI.WebControls.TableCell from the System.Web.UI.WebControls.TableCellCollection.
Use this method to remove the specified System.Web.UI.WebControls.TableCell from a System.Web.UI.WebControls.TableCellCollection. The System.Web.UI.WebControls.TableCell to remove from the System.Web.UI.WebControls.TableCellCollection.
RemoveAt
Removes a System.Web.UI.WebControls.TableCell from the System.Web.UI.WebControls.TableCellCollection at the specified index.
Use this method to remove a System.Web.UI.WebControls.TableCell from a System.Web.UI.WebControls.TableCellCollection at the specified index. The index of the System.Web.UI.WebControls.TableCell to remove from the System.Web.UI.WebControls.TableCellCollection.
IList.Add
IList.Contains
IList.IndexOf
IList.Insert
IList.Remove
TableCellControlBuilder class (System.Web.UI.WebControls)
ToString
Description
Interacts with the parser to build a System.Web.UI.WebControls.TableCell control.
To create a custom control builder for a System.Web.UI.WebControls.TableCell derived control, you need to inherit from this class.
TableCellControlBuilder
Example Syntax:
ToString
ControlType
FChildrenAsProperties
FIsNonParserAccessor
HasAspCode
ID
InDesigner
NamingContainerType
Parser
TagName
AllowWhitespaceLiterals
Specifies whether white space literals are allowed.
Return Value: false for all cases.
This method overrides System.Web.UI.ControlBuilder.AllowWhitespaceLiterals to ignore white space in the System.Web.UI.WebControls.TableCell control.
TableHeaderCell class (System.Web.UI.WebControls)
ToString
Description
Represents a heading cell within a System.Web.UI.WebControls.Table control.
The System.Web.UI.WebControls.TableHeaderCell class represents a heading cell in a System.Web.UI.WebControls.Table control. You can use the System.Web.UI.WebControls.TableCell.Text property to specify or determine the contents of the heading cell.
TableHeaderCell
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.TableHeaderCell class.
Use this contructor to create and initialize a new instance of the System.Web.UI.WebControls.TableHeaderCell class.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
ColumnSpan
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
HorizontalAlign
ID
IsTrackingViewState
NamingContainer
Page
Parent
RowSpan
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
Text
ToolTip
UniqueID
VerticalAlign
ViewState
ViewStateIgnoresCase
Visible
Width
Wrap
TableItemStyle class (System.Web.UI.WebControls)
TrackViewState
Description
Specifies the style for an item in a table control.
The System.Web.UI.WebControls.TableItemStyle class represents the style properties for an item in the System.Web.UI.WebControls.Table control. You can control the a Specifies the style of the table item.
TableItemStyle
Example Syntax:
TrackViewState
Creates a new instance of the System.Web.UI.WebControls.TableItemStyle class.
TableItemStyle
Example Syntax:
TrackViewState
Creates a new instance of the System.Web.UI.WebControls.TableItemStyle class with the specified state bag. The specified state bag.
BackColor
BorderColor
BorderStyle
BorderWidth
Container
CssClass
DesignMode
Events
Font
ForeColor
Height
HorizontalAlign
TrackViewState
Description
Gets or sets the horizontal alignment of the cell content.
IsEmpty
IsTrackingViewState
Site
VerticalAlign
TrackViewState
Description
Gets or sets the vertical alignment of the cell content.
ViewState
Width
Wrap
TrackViewState
Description
Gets or sets a value indicating whether the cell content wraps within the cell.
AddAttributesToRender
Adds information about horizontal alignment, vertical alignment, and wrap to the list of attributes to render. The output stream that renders HTML content to the client. The control that the style refers to.
CopyFrom
Copies non-blank elements from the specified style, overwriting existing style elements if necessary. The style to copy.
MergeWith
Copies non-blank elements from the specified style, but will not overwrite any existing style elements. The style to copy.
Reset
Clears out any defined style elements from the state bag.
TableRow class (System.Web.UI.WebControls)
TrackViewState
Description
Represents a row in a System.Web.UI.WebControls.Table control.
The System.Web.UI.WebControls.TableRow class represents a row in a System.Web.UI.WebControls.Table control.
TableRow
Example Syntax:
TrackViewState
Initializes a new instance of the System.Web.UI.WebControls.TableRow class.
Use this constructor to create and initialize a new instance of the System.Web.UI.WebControls.TableRow class.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
Cells
TrackViewState
Description
Gets a collection of System.Web.UI.WebControls.TableCell objects that represent the cells of a row in a System.Web.UI.WebControls.Table control.
Use this property to programmatically control a collection of System.Web.UI.WebControls.TableCell objects that represent the cells from a row of the System.Web.UI.WebControls.Table control. You can programmatically add, insert, or remove a System.Web.UI.WebControls.TableCell object from the collection.
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
HorizontalAlign
TrackViewState
Description
Gets or sets the horizontal alignment of the contents in the row.
Use the System.Web.UI.WebControls.TableRow.HorizontatAlign property to specify the horizontal alignment of the contents of the row. The following table lists the possible values.
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
VerticalAlign
TrackViewState
Description
Gets or sets the vertical alignment of the contents in the row.
Use the System.Web.UI.WebControls.TableRow.VerticalAlign property to specify the vertical alignment of the contents of the row. The following table lists the possible values.
ViewState
ViewStateIgnoresCase
Visible
Width
CreateControlCollection
CreateControlStyle
A protected method. Creates a table item control style.
Return Value: A System.Web.UI.WebControls.Style that specifies the table item control style.
TableRowCollection class (System.Web.UI.WebControls)
TrackViewState
Description
Encapsulates a collection of System.Web.UI.WebControls.TableRow objects that represent a single row in a System.Web.UI.WebControls.Table control. This class cannot be inherited.
Use this class to programmatically manage a collection of System.Web.UI.WebControls.TableRow objects. This class is commonly used to add or remove rows from a System.Web.UI.WebControls.Table control.
Count
TrackViewState
Gets the number of System.Web.UI.WebControls.TableRow objects in the System.Web.UI.WebControls.TableRowCollection.
Use this property to determine the number of rows in the System.Web.UI.WebControls.TableRowCollection. The System.Web.UI.WebControls.TableRowCollection.Count property is often used when iterating through the collection to determine the upper bound.
IsReadOnly
TrackViewState
Gets a value indicating whether the System.Web.UI.WebControls.TableRowCollection is read-only.
This property always returns false to indicate that the System.Web.UI.WebControls.TableRowCollection can be written to in all cases.
IsSynchronized
TrackViewState
Gets a value indicating whether access to the System.Web.UI.WebControls.TableRowCollection is synchronized (thread-safe).
This property is derived from System.Collections.ICollection and is overridden to always return false
Item
TrackViewState
Gets a System.Web.UI.WebControls.TableRow from the System.Web.UI.WebControls.TableRowCollection at the specified index.
Use this indexer to get an individual System.Web.UI.WebControls.TableRow from the System.Web.UI.WebControls.TableRowCollection at the specified index using simple array notation. An ordinal index value that specifies which System.Web.UI.WebControls.TableRow to return.
SyncRoot
TrackViewState
Gets the object that can be used to synchronize access to the System.Web.UI.WebControls.TableRowCollection.
The object returned in this implementation is the System.Web.UI.WebControls.TableRowCollection object itself.
Add
Appends the specified System.Web.UI.WebControls.TableRow to the end of the System.Web.UI.WebControls.TableRowCollection.
Use this method to add a System.Web.UI.WebControls.TableRow to the end of a System.Web.UI.WebControls.TableRowCollection. The System.Web.UI.WebControls.TableRow to add to the System.Web.UI.WebControls.TableRowCollection.
AddAt
Adds the specified System.Web.UI.WebControls.TableRow to the System.Web.UI.WebControls.TableRowCollection at the specified index location.
Use this method to insert the specified System.Web.UI.WebControls.TableRow in a System.Web.UI.WebControls.TableRowCollection at the specified index. The location in the System.Web.UI.WebControls.TableRowCollection at which to add the System.Web.UI.WebControls.TableRow. The System.Web.UI.WebControls.TableRow to add to the System.Web.UI.WebControls.TableRowCollection.
AddRange
Clear
Removes all System.Web.UI.WebControls.TableRow controls from the System.Web.UI.WebControls.TableRowCollection.
Use this method to remove all System.Web.UI.WebControls.TableRow objects from the System.Web.UI.WebControls.TableRowCollection and set the System.Web.UI.WebControls.TableRowCollection.Count property to 0.
CopyTo
Copies the items from the System.Web.UI.WebControls.TableRowCollection to the specified System.Array, starting with the specified index in the System.Array.
Use this method to copy the contents of the System.Web.UI.WebControls.TableRowCollection into the specified System.Array, starting at the specified index. A zero-based System.Array that receives the copied items from the System.Web.UI.WebControls.TableRowCollection. The first position in the specified System.Array to receive copied contents.
GetEnumerator
Returns an System.Collections.IEnumerator that contains all System.Web.UI.WebControls.TableRow objects within the System.Web.UI.WebControls.TableRowCollection.
Return Value: A System.Collections.IEnumerator that contains all System.Web.UI.WebControls.TableRow objects within the System.Web.UI.WebControls.TableRowCollection.
Use this method to create a System.Collections.IEnumerator that can be iterated through easily to get each item in the System.Web.UI.WebControls.TableRowCollection.
GetRowIndex
Returns a value that represents the index of the specified System.Web.UI.WebControls.TableRow from the System.Web.UI.WebControls.TableRowCollection.
Return Value: The ordinal index position of the specified System.Web.UI.WebControls.TableRow within the collection. The default is −1, which indicates that the specified System.Web.UI.WebControls.TableRow has not been found.
Use this method to determine the index of the specified System.Web.UI.WebControls.TableRow in the System.Web.UI.WebControls.TableRowCollection. If the specified System.Web.UI.WebControls.TableRow is not found, an index of −1 is returned. The System.Web.UI.WebControls.TableRow to search for in the System.Web.UI.WebControls.TableRowCollection.
Remove
Removes the specified System.Web.UI.WebControls.TableRow from the System.Web.UI.WebControls.TableRowCollection.
Use this method to remove the specified System.Web.UI.WebControls.TableRow from a System.Web.UI.WebControls.TableRowCollection. The System.Web.UI.WebControls.TableRow to remove from the System.Web.UI.WebControls.TableRowCollection.
RemoveAt
Removes a System.Web.UI.WebControls.TableRow from the System.Web.UI.WebControls.TableRowCollection at the specified index.
Use this method to remove a System.Web.UI.WebControls.TableRow from the System.Web.UI.WebControls.TableRowCollection at the specified index. The index of the System.Web.UI.WebControls.TableRow to remove from the System.Web.UI.WebControls.TableRowCollection.
IList.Add
IList.Contains
IList.IndexOf
IList.Insert
IList.Remove
TableStyle class (System.Web.UI.WebControls)
ToString
Description
Specifies the style for a table control.
This is used primarily by control developers.
TableStyle
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.TableStyle class using default values.
TableStyle
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.TableStyle class with the specified state bag information.
BackColor
BackImageUrl
ToString
Description
Gets or sets the URL of an image to display in the background of a table control.
The image will be tiled if it is smaller than the table.
BorderColor
BorderStyle
BorderWidth
CellPadding
ToString
Description
Gets or sets the distance between the border and the contents of the table cell.
CellSpacing
ToString
Gets or sets the distance between table cells.
Container
CssClass
DesignMode
Events
Font
ForeColor
GridLines
ToString
Description
Gets or sets the gridlines property of the table.
Height
HorizontalAlign
ToString
Description
Gets or sets the horizontal alignment of the table within the page.
IsEmpty
IsTrackingViewState
Site
ViewState
Width
AddAttributesToRender
Adds information about the background image, callspacing, cellpadding, gridlines, and alignment to the list of attributes to render. The output stream that renders HTML content to the client. The control associated with the style.
CopyFrom
Copies non-blank elements from the specified style, overwriting existing style elements if necessary. The style to copy.
MergeWith
Copies non-blank elements from the specified style, but will not overwrite any existing style elements. The style to copy.
Reset
Clears out any defined style elements from the state bag.
TargetConverter class (System.Web.UT.WebControls)
TrackViewState
Description
TargetConverter
Example Syntax:
TrackViewState
GetStandardValues
GetStandardValuesExclusive
GetStandardValuesSupported
TemplateColumn class (System.Web.UI.WebControls)
ToString
Description
A column type for the System.Web.UI.WebControls.DataGrid control that allows you to customize the layout of controls in the column.
Use the System.Web.UI.WebControls.TemplateColumn column type in a System.Web.UI.WebControls.DataGrid control to create a column with a customized control layout.
TemplateColumn
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.TemplateColumn class.
Use this constructor to create and initializes a new instance of the System.Web.UI.WebControls.TemplateColumn class.
DesignMode
EditItemTemplate
ToString
Description
Gets or sets the template for this column for the item selected for editing in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.TemplateColumn.EditItemTemplate property to control the contents of the item selected for editing in the column of the System.Web.UI.WebControls.DataGrid control.
FooterStyle
FooterTemplate
ToString
Description
Gets or sets the template for the tooter section of this column in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataList.FooterTemplate property to control the contents of the tooter section.
FooterText
HeaderImageUrl
HeaderStyle
HeaderTemplate
ToString
Description
Gets or sets the template for the heading section of this column in the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.DataList.HeaderTemplate property to control the contents of the heading section. The appearance of the header section is controlled by the System.Web.UI.WebControls.DataList.HeaderStyle property.
HeaderText
IsTrackingViewState
ItemStyle
ItemTemplate
ToString
Description
Gets or sets the template for the items in this column of the System.Web.UI.WebControls.DataGrid control.
Use the System.Web.UI.WebControls.TemplateColumn.ItemTemplate property to control the contents of the items in the System.Web.UI.WebControls.DataList control.
Owner
SortExpression
ViewState
Visible
InitializeCell
TextAlign enumeration (System.Web.UI.WebControls)
TrackViewState
Description
Specifies whether the text associated with a checkbox or radio button control appears to the left or to the right of the control.
The System.Web.UI.WebControls.TextAlign enumeration represents the different text alignment options for checkbox and radio button controls.
TrackViewState
Text associated with a checkbox or radio button control appears to the left of the control.
TrackViewState
Text associated with a checkbox or radio button control appears to the right of the control.
TextBox class (System.Web.UI.WebControls)
ToString
Description
Constructs a text box and defines its properties.
The System.Web.UI.WebControls.TextBox server control is an input control that lets the user enter text. By default, the System.Web.UI.WebControls.TextBox.TextMode of the text box is SingleLine, but it can be modified to be MultiLine or Password.
TextBox
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.TextBox class.
AccessKey
Attributes
AutoPostBack
ToString
Description
Gets or sets a value indicating whether an automatic postback to the server will occur whenever the user changes the content of the text box.
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Columns
ToString
Description
Gets or sets the display width of the text box in characters.
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
Enabled
EnableViewState
Events
Font
ForeColor
HasChildViewState
Height
ID
IsTrackingViewState
MaxLength
ToString
Description
Gets or sets the maximum number of characters allowed in the text box.
This property is not applicable when the System.Web.UI.WebControls.TextBox.TextMode property is set to TextBoxMode.MultiLine.
NamingContainer
Page
Parent
ReadOnly
ToString
Description
Whether the textbox is in read-only mode.
Rows
ToString
Gets or sets the display height of a multiline text box.
This property is only applicable when the System.Web.UI.WebControls.TextBox.TextMode property is set to TextBoxMode.MultiLine.
Site
Style
TabIndex
TagKey
ToString
Description
A protected property. Gets the HTML tag for the text box control.
TagName
TemplateSourceDirectory
Text
ToString
Description
Gets or sets the text content of the text box.
TextMode
ToString
Gets or sets the behavior mode of the text box.
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
Wrap
ToString
Description
Gets or sets a value indicating whether the text content wraps within the text box.
This property is only applicable when the System.Web.UI.WebControls.TextBox.TextMode property is set to TextBoxMode.MultiLine.
ToString
Description
Occurs when the content of the text box is changed upon server postback.
AddAttributesToRender
AddParsedSubObject
Overridden to only allow literal controls to be added as Text property.
OnPreRender
OnTextChanged
Raises the TextChanged event.
Render
IPostBackDataHandler.LoadPostData
IPostBackDataHandler.RaisePostDataChangedEvent
TextBoxControlBuilder class (System.Web.UI.WebControls)
TrackViewState
Description
Interacts with the parser to build a System.Web.UI.WebControls.TextBox control.
To create a custom control builder for a System.Web.UI.WebControls.TextBox derived control, you need to inherit from this class.
TextBoxControlBuilder
Example Syntax:
TrackViewState
ControlType
FChildrenAsProperties
FIsNonParserAccessor
HasAspCode
ID
InDesigner
NamingContainerType
Parser
TagName
AllowWhitespaceLiterals
Specifies whether white space literals are allowed.
Return Value: false for all cases.
This method overrides System.Web.UI.ControlBuilder.AllowWhitespaceLiterals to ignore white space in the System.Web.UI.WebControls.TextBox control.
HtmlDecodeLiterals
TextBoxMode enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the behavior mode of the text box.
The System.Web.UI.WebControls.TextBoxMode enumeration represents the different display options for System.Web.UI.WebControls.TextBox controls.
ToString
Multi line entry mode.
ToString
Password entry mode.
ToString
Single-line entry mode.
TitleFormat enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the title format for the displayed month in the System.Web.UI.WebControls.Calendar control.
The System.Web.UI.WebControls.TitleFormat enumeration represents the different title formats for the System.Web.UI.WebControls.Calendar control.
ToString
Title displayed with only the month but not the year. For example, “January”.
ToString
Title displayed with both the month and the year. For example, “January 2000”.
Unit structure (System.Web.UI.WebControls)
ToString
Description
Defines the fields, properties, and methods of the System.Web.UI.WebControls.Unit structure.
ToString
Specifies an empty unit. This field is read-only.
Unit
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Unit structure with the specified double-precision floating point number as the unit value and Pixel as the (default) unit type. Represents the specified unit value.
Unit
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Unit structure with the specified 32-bit signed integer as the unit value and Pixel as the (default) unit type. Represents the specified unit value.
Unit
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Unit structure with the specified text string that contains the unit value and unit type. If the unit type is not specified, the default is Pixel . The specified text string that contains the unit value and unit type.
Unit
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.Unit structure with the specified double-precision floating point number as the unit value and the specified System.Web.UI.WebControls.UnitType as the unit type. Represents the specified unit value. Represents the specified unit type.
Unit
Example Syntax:
ToString
IsEmpty
ToString
Gets a value indicating whether the System.Web.UI.WebControls.Unit is empty.
Type
ToString
Gets or sets the type of the System.Web.UI.WebControls.Unit.
Value
ToString
Gets the value of the System.Web.UI.WebControls.Unit.
Equals
Compares this System.Web.UI.WebControls.Unit with the specified object.
Return Value: true if this System.Web.UI.WebControls.Unit has the same value and type as the specified object; otherwise, false . The specified object for comparison.
GetHashCode
op_Equality
Compares two units to find out if they have the same value and type.
Return Value: true if both units have the same value and type; otherwise, false . One of the two units being compared. The other of the two units being compared.
op_Implicit
Implicitly creates a System.Web.UI.WebControls.Unit of type Pixel from the specified 32-bit unsigned integer. The specified 32-bit unsigned integer for creating a Unit.
op_Inequality
Compares two units to find out if they have different values and/or types.
Return Value: true if both units have different values or different types; otherwise, false. One of the two units being compared. The other of the two units being compared.
Parse
Parse
Percentage
Creates a System.Web.UI.WebControls.Unit of type Percentage from the specified 32-bit signed integer.
Return Value: A System.Web.UI.WebControls.Unit that represents the unit created. The specified double precision floating point number for creating a unit.
Pixel
Creates a System.Web.UI.WebControls.Unit of type Pixel from the specified 32-bit signed integer.
Return Value: A System.Web.UI.WebControls.Unit that represents the unit created. The specified 32-bit signed integer for creating a unit.
Point
Creates a System.Web.UI.WebControls.Unit of type Point from the specified 32-bit signed integer.
Return Value: A System.Web.UI.WebControls.Unit that represents the unit created. The specified 32-bit signed integer for creating a unit.
ToString
Converts a System.Web.UI.WebControls.Unit to a System.String.
Return Value: A System.String represents this System.Web.UI.WebControls.Unit.
ToString
UnitConverter class (System.Web.UI.WebControls)
ToString
Description
Specifies an interface to be overridden to provide unit conversion services. The base unit converter class.
UnitConverter
Example Syntax:
ToString
CanConvertFrom
Returns a value indicating whether the unit converter can convert from the specified source type.
Return Value: true if the source type can be converted from; otherwise, false . An System.ComponentModel.ITypeDescriptorContext that specifies the context of the object to convert. The type of the source.
ConvertFrom
Performs type conversion from the specified context, object and argument list.
Return Value: The object resulting from conversion. An System.ComponentModel.ITypeDescriptorContext that indicates the context of the object to convert. A System.Globalization.CultureInfo object that represents information about a culture such as language, calendar system, and so on. This parameter is not used in this method. It is reserved for future versions of this method. You can optionally pass in null for this parameter. The object to convert.
ConvertTo
Performs type conversion to the specified destination type given the specified context, object and argument list.
Return Value: The object resulting from conversion. An System.ComponentModel.ITypeDescriptorContext that indicates the context of the object to convert. A System.Globalization.CultureInfo object that represents information about a culture such as language, calendar system, and so on. This parameter is not used in this method. It is reserved for future versions of this method. You can optionally pass in null for this parameter. The object to convert. The type to convert to.
UnitType enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the unit of measurement.
The System.Web.UI.WebControls.UnitType enumeration represents the different supported measurement units. Measurements can be represented in pixels, points, picas, inches, millimeters, centimeters, percentages, em, or ex.
ToString
Measurement is in centimeters.
ToString
Measurement is relative to the height of the parent element's font.
ToString
Measurement is relative to the height of the lowercase letter x of the parent element's font.
ToString
Measurement is in inches.
ToString
Measurement is in millimeters.
ToString
Measurement is a percentage relative to the parent element.
ToString
Measurement is in picas. A pica represents 12 points.
ToString
Measurement is in pixels.
ToString
Measurement is in points. A point represents 1/72 of an inch.
ValidatedControlConverter class (System.Web.UI.WebControls)
ToString
Description
Shows a list of validatable controls in the Properties window.
GetStandardValues
Returns a collection of standard values retrieved from the context specified by the specified type descriptor.
Return Value: A StandardValuesCollection that represents the standard values collected from the specified context. A type descriptor that specifies the location of the context to convert from.
GetStandardValuesExclusive
Gets whether or not the context specified contains exclusive standard values.
Return Value: true if the specified context contains exclusive standard values, otherwise false. A type descriptor that indicates the context to convert from.
GetStandardValuesSupported
Gets whether or not the specified context contains supported standard values.
Return Value: true if the specified context conatins supported standard values, otherwise false. A type descriptor that indicates the context to convert from.
ValidationCompareOperator enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the validation comparison operators used by the System.Web.UI.WebControls.CompareValidator control.
The System.Web.UI.WebControls.ValidationCompareOperator enumeration represents the comparison operations that can be performed by the System.Web.UI.WebControls.CompareValidator control.
ToString
A comparison for data type only.
ToString
A comparison for equality.
ToString
A comparison for greater than.
ToString
A comparison for greater than or equal to.
ToString
A comparison for less than.
ToString
A comparison for less than or equal to.
ToString
A comparison for inequality.
ValidationDataType enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the validation data types used by the System.Web.UI.WebControls.CompareValidator and System.Web.UI.WebControls.RangeValidator controls.
The System.Web.UI.WebControls.ValidationDataType enumeration represents the different data types that the System.Web.UI.WebControls.CompareValidator and System.Web.UI.WebControls.RangeValidator controls can validate.
ToString
A currency data type.
ToString
A date data type.
ToString
A double data type.
ToString
An integer data type.
ToString
A string data type.
ValidationSummary class (System.Web.UI.WebControls)
ToString
Description
Displays a summary of all validation errors inline on a Web page, in a message box, or both.
The System.Web.UI.WebControls.ValidationSummary class is used to summarize the error messages from all validators on a Web page, in a single location. The summary can be displayed as a list, as a bulleted list, or as a single paragraph based on the System.Web.UI.WebControls.ValidationSummary.DisplayMode property.
ValidationSummary
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.ValidationSummary class.
The following table shows the initial property value for an instance of System.Web.UI.WebControls.ValidationSummary.
AccessKey
Attributes
BackColor
BorderColor
BorderStyle
BorderWidth
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ControlStyleCreated
CssClass
DisplayMode
ToString
Description
Gets or sets the display mode of the validation summary.
Use this property to specify the display format of a System.Web.UI.WebControls.ValidationSummary control. The summary may be displayed as a list, as a bulleted list, or as a single paragraph.
EnableClientScript
ToString
Gets or sets a value indicating whether client-side validation is attempted on the browser.
Use this property to enable or disable client-side validation on the browser. When set to true, client-side validation is performed on the browser if the browser supports that feature. When set to false, no client-side validation is attempted, the System.Web.UI.WebControls.ValidationSummary control only updates itself on round-trips to the server, and the System.Web.UI.WebControls.ValidationSummary.ShowMessageBox property has no effect.
Enabled
EnableViewState
Events
Font
ForeColor
ToString
Description
Gets or sets the fore color of the control.
Use this property to specify the color that error messages from validation controls are displayed.
HasChildViewState
HeaderText
ToString
Description
Gets or sets the header text displayed at the top of the summary.
Use this property to display a title for the System.Web.UI.WebControls.ValidationSummary control.
Height
ID
IsTrackingViewState
NamingContainer
Page
Parent
ShowMessageBox
ToString
Description
Gets or sets a value indicating whether the validation summary is displayed in a message box.
This property can be used in addition to the System.Web.UI.WebControls.ValidationSummary.ShowSummary property to control where the validation summary is displayed. If this property and System.Web.UI.WebControls.ValidationSummary.EnableClientScript are both set to true, the validation summary is displayed in a message box. If System.Web.UI.WebControls.ValidationSummary.EnableClientScript is set to false, this property has no effect.
ShowSummary
ToString
Gets or sets a value indicating whether the validation summary is displayed inline.
This property can be used in addition to the System.Web.UI.WebControls.ValidationSummary.ShowMessageBox property to control where the validation summary is displayed. If this property is set to true, the validation summary is displayed on the Web page.
Site
Style
TabIndex
TagKey
TagName
TemplateSourceDirectory
ToolTip
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
AddAttributesToRender
AddAttributesToRender method.
OnPreRender
PreRender method.
Render
Render method.
ValidationSummaryDisplayMode enumeration (System.Web.UI.WebControls)
TrackViewState
Description
Specifies the validation summary display mode used by the System.Web.UI.WebControls.ValidationSummary control.
The System.Web.UI.WebControls.ValidationSummaryDisplayMode enumeration represents the different display formats of a System.Web.UI.WebControls.ValidationSummary control.
TrackViewState
Validation summary displayed in a bulleted list.
TrackViewState
Validation summary displayed in a list.
TrackViewState
Validation summary displayed in a single paragraph.
ValidatorDisplay enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the display behavior of error messages in validation controls.
The ValidatorDisplaySystem.Web.UI.WebControls enumeration represents the different display behaviors of error messages in validation controls.
ToString
Validator content dynamically added to the page when validation faills.
ToString
Validator content never displayed inline.
ToString
Validator content physically part of the page layout.
VerticalAlign enumeration (System.Web.UI.WebControls)
ToString
Description
Specifies the vertical alignment of an object or text in a control.
The System.Web.UI.WebControls.VerticalAlign enumeration represents the different vertical alignment options for an object or text in a control.
ToString
Text or object is aligned with the bottom of the enclosing control.
ToString
Text or object is aligned with the center of the enclosing control.
ToString
Vertical alignment is not set.
ToString
Text or object is aligned with the top of the enclosing control.
WebColorConverter class (System.Web.UT.WebControls)
ToString
Description
WebColorConverter
Example Syntax:
ToString
ConvertFrom
ConvertTo
WebControl class (System.Web.UI.WebControls)
ToString
Description
Serves as the base class that defines the methods, properties and events common to all controls in the System.Web.UI.WebControls namespace.
Certain properties of the base control may not render on downlevel browsers for some or all controls. For example, the System.Web.UI.WebControls.WebControl.AccessKey property will not render on downlevel browsers for any controls. See specific property for more details.
WebControl
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.WebControl class with a Span HTML tag.
WebControl
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.WebControl class using the specified HTML tag. One of the System.Web.UI.HtmlTextWriteTag values.
WebControl
Example Syntax:
ToString
Initializes a new instance of the System.Web.UI.WebControls.WebControl class with the specified HTML tag. An HTML tag.
AccessKey
ToString
Gets or sets the keyboard shortcut key (AccessKey) for setting focus to the Web control.
This property will not render on downlevel browsers for any controls. It is not HTML 4.0 and will only work in IE 4 or higher.
Attributes
ToString
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
This property will render on downlevel browsers for all controls.
BackColor
ToString
Gets or sets the background color of the Web control.
This property will render on downlevel browsers for some controls only. For example, System.Web.UI.WebControls.Table, System.Web.UI.WebControls.Panel, System.Web.UI.WebControls.DataGrid, System.Web.UI.WebControls.Calendar, and System.Web.UI.WebControls.ValidationSummary. It will also work for System.Web.UI.WebControls.CheckBoxList, System.Web.UI.WebControls.RadioButtonList and System.Web.UI.WebControls.DataList if their RepeatLayout property is Table and not Flow.
BorderColor
ToString
Gets or sets the border color of the Web control.
The property will render downlevel only for the same table-based controls like the System.Web.UI.WebControls.WebControl.BackColor property. However, it is output as the “bordercolor” attribute which is not part of the HTML 3.2 standard. It works for Navigaor 4 and higher, and IE 3 and higher, but not most other browsers.
BorderStyle
ToString
Gets or sets the border style of the Web control.
This property will not render on downlevel browsers for any controls.
BorderWidth
ToString
Gets or sets the border width of the Web control.
Use the System.Web.UI.WebControls.WebControl.BorderWidth property to specify a border width for a control.
ChildControlsCreated
ClientID
Context
Controls
ControlStyle
ToString
Description
Gets the style of the Web control. This property is primarily used by control developers.
ControlStyleCreated
ToString
CssClass
ToString
Gets or sets the CSS class rendered by the Web control.
This property will render on downlevel browsers for all controls.
Enabled
ToString
Gets or sets a value indicating whether the Web control is enabled.
This property will render on downlevel browsers for some controls only.
EnableViewState
Events
Font
ToString
Description
Gets font information of the Web control.
This property includes subproperties that can be accessed declaratively in the form of “Font-Bold” or programmatically in the form of “Font.Bold”.
ForeColor
ToString
Gets or sets the foreground color (typically the color of the text) of the Web control.
This property will render on downlevel browsers for almost all controls, except the System.Web.UI.WebControls.Image, System.Web.UI.WebControls.AdRotator, System.Web.UI.WebControls.HyperLink and System.Web.UI.WebControls.LinkButton controls. In addition, it will be rendered as tags on downlevel browsers.
HasChildViewState
Height
ToString
Description
Gets or sets the height of the Web control.
This property will render on downlevel browsers for some controls only. It will not render downlevel for System.Web.UI.WebControls.Label, System.Web.UI.WebControls.HyperLink, System.Web.UI.WebControls.LinkButton, any validator controls, or for System.Web.UI.WebControls.CheckBoxList, System.Web.UI.WebControls.RadioButtonList and System.Web.UI.WebControls.DataList when their RepeatLayout property is Flow. Furthermore, only unit types of Pixel and percentage will work.
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
Style
ToString
Description
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web control.
This property will render on downlevel browsers for all controls.
TabIndex
ToString
Gets or sets the tab index of the Web control.
Use the System.Web.UI.WebControls.WebControl.TabIndex property to specify or determine the tab index of a control on the Web Page.
TagKey
ToString
TagName
ToString
A protected property. Gets the name of the control tag. This property is primarily used by control developers.
TemplateSourceDirectory
ToolTip
ToString
Description
Gets or sets the tool tip for the Web control to be displayed when the mouse cursor is over the control.
This property will not render on downlevel browsers for any controls.
UniqueID
ViewState
ViewStateIgnoresCase
Visible
Width
ToString
Description
Gets or sets the width of the Web control.
This property will render on downlevel browsers for some controls only. It will not render downlevel for System.Web.UI.WebControls.Label, System.Web.UI.WebControls.HyperLink, System.Web.UI.WebControls.LinkButton, any validator controls, or for System.Web.UI.WebControls.CheckBoxList, System.Web.UI.WebControls.RadioButtonList and System.Web.UI.WebControls.DataList when their RepeatLayout property is Flow. Furthermore, only unit types of Pixel and Percentage will work.
AddAttributesToRender
Adds to the specified writer those HTML attributes and styles that need to be rendered. This method is primarily used by control developers. The output stream that renders HTML content to the client.
ApplyStyle
Copies any non-blank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. The style to be copied.
CopyBaseAttributes
Copies the System.Web.UI.WebControls.WebControl.AccessKey, System.Web.UI.WebControls.WebControl.Enabled, System.Web.UI.WebControls.WebControl.ToolTip, System.Web.UI.WebControls.WebControl.TabIndex, and System.Web.UI.WebControls.WebControl.Attributes properties onto the Web control from the specified source control. The source control with properties to be copied onto the Web control.
CreateControlStyle
A protected method. Creates the style object that is used internally to implement all style-related properties. Controls may override to create an appropriately typed style.
Return Value: A System.Web.UI.WebControls.Style that is used to implement all style-related properties of the control.
LoadViewState
Loads previously saved state. Overridden to handle ViewState, Style, and Attributes. Previously saved state.
MergeStyle
Copies any non-blank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is primarily used by control developers. The style to be copied.
Render
Renders the control into the specified writer. The output stream that renders HTML content to the client.
RenderBeginTag
Renders the HTML begin tag of the control into the specified writer. This method is primarily used by control developers.
This is made public so other controls can render multiple controls in between the begin tag and the end tag. The output stream that renders HTML content to the client.
RenderContents
Renders the contents of the control into the specified writer. This method is primarily used by control developers. The output stream that renders HTML content to the client.
RenderEndTag
Renders the HTML end tag of the control into the specified writer. This method is primarily used by control developers.
This is made public so other controls can render multiple controls in between the begin tag and the end tag. The output stream that renders HTML content to the client.
SaveViewState
A protected method. Saves any state that was modified after the System.Web.UI.WebControls.Style.TrackViewState method was invoked.
IAttributeAccessor.GetAttribute
IAttributeAccessor.SetAttribute
TrackViewState
Marks the beginning for tracking state changes on the control. Any changes made after “mark” will be tracked and saved as part of the control viewstate.
Xml class (System.Web.UI.WebControls)
TrackViewState
Description
Displays the contents of an XML document or the results of an XSL Transform.
Use the System.Web.UI.WebControls.Xml control to display the contents of an XML document or the results of an XSL Transform.
Xml
Example Syntax:
TrackViewState
ChildControlsCreated
ClientID
Context
Controls
Document
TrackViewState
Description
Gets or sets the System.Xml.XmlDocument object to display.
DocumentContent
TrackViewState
Gets or sets a string that contains the XML document to display in the System.Web.UI.WebControls.Xml control.
DocumentSource
TrackViewState
Gets or sets the URL to an XML document to display in the System.Web.UI.WebControls.Xml control.
EnableViewState
Events
HasChildViewState
ID
IsTrackingViewState
NamingContainer
Page
Parent
Site
TemplateSourceDirectory
Transform
TrackViewState
Description
Gets or sets the System.Xml.Xsl.XslTransform object that formats the XML document before it is written to the output stream.
TransformArgumentList
TrackViewState
TransformSource
TrackViewState
Gets or sets the URL to an XSL Transform document that formats the XML document before it is written to the output stream.
UniqueID
ViewState
ViewStateIgnoresCase
Visible
AddParsedSubObject
Render
Renders the results to the o
Exemplary Computing System and Environment
The exemplary computing environment 400 is only one example of a computing environment and is not intended to suggest any limitation as to the scope of use or functionality of the computer and network architectures. Neither should the computing environment 400 be interpreted as having any dependency or requirement relating to any one or combination of components illustrated in the exemplary computing environment 400.
The framework 132 may be implemented with numerous other general purpose or special purpose computing system environments or configurations. Examples of well known computing systems, environments, and/or configurations that may be suitable for use include, but are not limited to, personal computers, server computers, multiprocessor systems, microprocessor-based systems, network PCs, minicomputers, mainframe computers, distributed computing environments that include any of the above systems or devices, and so on. Compact or subset versions of the framework may also be implemented in clients of limited resources, such as cellular phones, personal digital assistants, handheld computers, or other communication/computing devices.
The framework 132 may be described in the general context of computer-executable instructions, such as program modules, being executed by one or more computers or other devices. Generally, program modules include routines, programs, objects, components, data structures, etc. that perform particular tasks or implement particular abstract data types. The framework 132 may also be practiced in distributed computing environments where tasks are performed by remote processing devices that are linked through a communications network. In a distributed computing environment, program modules may be located in both local and remote computer storage media including memory storage devices.
The computing environment 400 includes a general-purpose computing device in the form of a computer 402. The components of computer 402 can include, by are not limited to, one or more processors or processing units 404, a system memory 406, and a system bus 408 that couples various system components including the processor 404 to the system memory 406.
The system bus 408 represents one or more of several possible types of bus structures, including a memory bus or memory controller, a peripheral bus, an accelerated graphics port, and a processor or local bus using any of a variety of bus architectures. By way of example, such architectures can include an Industry Standard Architecture (ISA) bus, a Micro Channel Architecture (MCA) bus, an Enhanced ISA (EISA) bus, a Video Electronics Standards Association (VESA) local bus, and a Peripheral Component Interconnects (PCI) bus also known as a Mezzanine bus.
Computer 402 typically includes a variety of computer readable media. Such media can be any available media that is accessible by computer 402 and includes both volatile and non-volatile media, removable and non-removable media.
The system memory 406 includes computer readable media in the form of volatile memory, such as random access memory (RAM) 410, and/or non-volatile memory, such as read only memory (ROM) 412. A basic input/output system (BIOS) 414, containing the basic routines that help to transfer information between elements within computer 402, such as during start-up, is stored in ROM 412. RAM 410 typically contains data and/or program modules that are immediately accessible to and/or presently operated on by the processing unit 404.
Computer 402 may also include other removable/non-removable, volatile/non-volatile computer storage media. By way of example,
The disk drives and their associated computer-readable media provide non-volatile storage of computer readable instructions, data structures, program modules, and other data for computer 402. Although the example illustrates a hard disk 416, a removable magnetic disk 420, and a removable optical disk 424, it is to be appreciated that other types of computer readable media which can store data that is accessible by a computer, such as magnetic cassettes or other magnetic storage devices, flash memory cards, CD-ROM, digital versatile disks (DVD) or other optical storage, random access memories (RAM), read only memories (ROM), electrically erasable programmable read-only memory (EEPROM), and the like, can also be utilized to implement the exemplary computing system and environment.
Any number of program modules can be stored on the hard disk 416, magnetic disk 420, optical disk 424, ROM 412, and/or RAM 410, including by way of example, an operating system 426, one or more application programs 428, other program modules 430, and program data 432. Each of the operating system 426, one or more application programs 428, other program modules 430, and program data 432 (or some combination thereof) may include elements of the programming framework 132.
A user can enter commands and information into computer 402 via input devices such as a keyboard 434 and a pointing device 436 (e.g., a “mouse”). Other input devices 438 (not shown specifically) may include a microphone, joystick, game pad, satellite dish, serial port, scanner, and/or the like. These and other input devices are connected to the processing unit 404 via input/output interfaces 440 that are coupled to the system bus 408, but may be connected by other interface and bus structures, such as a parallel port, game port, or a universal serial bus (USB).
A monitor 442 or other type of display device can also be connected to the system bus 408 via an interface, such as a video adapter 444. In addition to the monitor 442, other output peripheral devices can include components such as speakers (not shown) and a printer 446 which can be connected to computer 402 via the input/output interfaces 440.
Computer 402 can operate in a networked environment using logical connections to one or more remote computers, such as a remote computing device 448. By way of example, the remote computing device 448 can be a personal computer, portable computer, a server, a router, a network computer, a peer device or other common network node, and so on. The remote computing device 448 is illustrated as a portable computer that can include many or all of the elements and features described herein relative to computer 402.
Logical connections between computer 402 and the remote computer 448 are depicted as a local area network (LAN) 450 and a general wide area network (WAN) 452. Such networking environments are commonplace in offices, enterprise-wide computer networks, intranets, and the Internet.
When implemented in a LAN networking environment, the computer 402 is connected to a local network 450 via a network interface or adapter 454. When implemented in a WAN networking environment, the computer 402 typically includes a modem 456 or other means for establishing communications over the wide network 452. The modem 456, which can be internal or external to computer 402, can be connected to the system bus 408 via the input/output interfaces 440 or other appropriate mechanisms. It is to be appreciated that the illustrated network connections are exemplary and that other means of establishing communication link(s) between the computers 402 and 448 can be employed.
In a networked environment, such as that illustrated with computing environment 400, program modules depicted relative to the computer 402, or portions thereof, may be stored in a remote memory storage device. By way of example, remote application programs 458 reside on a memory device of remote computer 448. For purposes of illustration, application programs and other executable program components such as the operating system are illustrated herein as discrete blocks, although it is recognized that such programs and components reside at various times in different storage components of the computing device 402, and are executed by the data processor(s) of the computer.
An implementation of the framework 132, and particularly, the API 142 or calls made to the API 142, may be stored on some form of computer readable media. Computer readable media can be any available media that can be accessed by a computer. By way of example, and not limitation, computer readable media may comprise “computer storage media”“Computer storage media” include volatile and non-volatile, removable and non-removable media implemented in any method or technology for storage of information such as computer readable instructions, data structures, program modules, or other data. Computer storage media includes, but is not limited to, RAM, ROM, EEPROM, flash memory or other memory technology, CD-ROM, digital versatile disks (DVD) or other optical storage, magnetic cassettes, magnetic tape, magnetic disk storage or other magnetic storage devices, or any other medium which can be used to store the desired information and which can be accessed by a computer.
“Communication media” typically embodies computer readable instructions, data structures, program modules, or other data in a modulated data signal, such as carrier wave or other transport mechanism. Communication media also includes any information delivery media. The term “modulated data signal” means a signal that has one or more of its characteristics set or changed in such a manner as to encode information in the signal. By way of example, and not limitation, communication media includes wired media such as a wired network or direct-wired connection, and wireless media such as acoustic, RF, infrared, and other wireless media. Combinations of any of the above are also included within the scope of computer readable media.
Alternatively, portions of the framework may be implemented in hardware or a combination of hardware, software, and/or firmware. For example, one or more application specific integrated circuits (ASICs) or programmable logic devices (PLDs) could be designed or programmed to implement one or more portions of the framework.
Although the invention has been described in language specific to structural features and/or methodological acts, it is to be understood that the invention defined in the appended claims is not necessarily limited to the specific features or acts described. Rather, the specific features and acts are disclosed as exemplary forms of implementing the claimed invention.
The present application claims priority under 35 U.S.C. §120 as a continuation of U.S. patent application Ser. No. 09/902,809, now U.S. Pat. No. 7,117,504, filed Jul. 10, 2001, to Anders et al., and titled “Application Program Interface for Network Software Platform”, the disclosure of which is hereby incorporated by reference in its entirety.
| Number | Name | Date | Kind |
|---|---|---|---|
| 5218699 | Brandle et al. | Jun 1993 | A |
| 5430876 | Schreiber et al. | Jul 1995 | A |
| 5689700 | Miller et al. | Nov 1997 | A |
| 5748962 | Brechtel et al. | May 1998 | A |
| 5761494 | Smedley et al. | Jun 1998 | A |
| 5822580 | Leung | Oct 1998 | A |
| 5903753 | Bramnick et al. | May 1999 | A |
| 5937406 | Balabine et al. | Aug 1999 | A |
| 5943424 | Berger et al. | Aug 1999 | A |
| 5956509 | Kevner | Sep 1999 | A |
| 5987517 | Firth et al. | Nov 1999 | A |
| 6061743 | Thatcher et al. | May 2000 | A |
| 6175878 | Seaman et al. | Jan 2001 | B1 |
| 6209124 | Vermeire et al. | Mar 2001 | B1 |
| 6256678 | Traughber et al. | Jul 2001 | B1 |
| 6275871 | Reinfelder et al. | Aug 2001 | B1 |
| 6282581 | Moore et al. | Aug 2001 | B1 |
| 6298354 | Saulpaugh et al. | Oct 2001 | B1 |
| 6349343 | Foody et al. | Feb 2002 | B1 |
| 6353830 | Yee et al. | Mar 2002 | B1 |
| 6360230 | Chan et al. | Mar 2002 | B1 |
| 6360266 | Pettus | Mar 2002 | B1 |
| 6381632 | Lowell | Apr 2002 | B1 |
| 6418448 | Sarkar | Jul 2002 | B1 |
| 6430593 | Lindsley | Aug 2002 | B1 |
| 6442548 | Balabine et al. | Aug 2002 | B1 |
| 6446253 | Mellmer | Sep 2002 | B1 |
| 6446256 | Hyman et al. | Sep 2002 | B1 |
| 6473794 | Guheen et al. | Oct 2002 | B1 |
| 6480865 | Lee et al. | Nov 2002 | B1 |
| 6487578 | Ranganathan | Nov 2002 | B2 |
| 6507856 | Chen et al. | Jan 2003 | B1 |
| 6519571 | Guheen et al. | Feb 2003 | B1 |
| 6536037 | Barrese et al. | Mar 2003 | B1 |
| 6598093 | Schmidt et al. | Jul 2003 | B1 |
| 6609158 | Nevarez et al. | Aug 2003 | B1 |
| 6615166 | Guheen et al. | Sep 2003 | B1 |
| 6643652 | Helgeson et al. | Nov 2003 | B2 |
| 6721713 | Guheen et al. | Apr 2004 | B1 |
| 6792605 | Roberts et al. | Sep 2004 | B1 |
| 6938079 | Anderson et al. | Aug 2005 | B1 |
| 6961750 | Burd et al. | Nov 2005 | B1 |
| 6968503 | Chang et al. | Nov 2005 | B1 |
| 7013340 | Burd et al. | Mar 2006 | B1 |
| 7228350 | Hong et al. | Jun 2007 | B2 |
| 20020073236 | Helgeson et al. | Jun 2002 | A1 |
| 20020092004 | Lee et al. | Jul 2002 | A1 |
| 20020099687 | Krishnaprasad et al. | Jul 2002 | A1 |
| 20020112078 | Yach | Aug 2002 | A1 |
| 20020152244 | Dean et al. | Oct 2002 | A1 |
| 20020169679 | Neumayer | Nov 2002 | A1 |
| 20020184401 | Kadel, Jr. et al. | Dec 2002 | A1 |
| 20030005048 | Risalvato | Jan 2003 | A1 |
| 20030028685 | Smith et al. | Feb 2003 | A1 |
| 20030051236 | Pace et al. | Mar 2003 | A1 |
| 20030074206 | Hoffman et al. | Apr 2003 | A1 |
| 20030084120 | Egli | May 2003 | A1 |
| 20030120665 | Fox et al. | Jun 2003 | A1 |
| 20030149934 | Worden | Aug 2003 | A1 |
| 20030167277 | Hejlsberg et al. | Sep 2003 | A1 |
| 20030167355 | Smith et al. | Sep 2003 | A1 |
| 20030167356 | Smith et al. | Sep 2003 | A1 |
| 20030172196 | Hejlsberg et al. | Sep 2003 | A1 |
| 20030177282 | Hejlsberg et al. | Sep 2003 | A1 |
| 20040083463 | Hawley | Apr 2004 | A1 |
| 20040117759 | Rippert, Jr. et al. | Jun 2004 | A1 |
| 20040205694 | James et al. | Oct 2004 | A1 |
| 20060294500 | Chiang | Dec 2006 | A1 |
| Number | Date | Country | |
|---|---|---|---|
| 20070100967 A1 | May 2007 | US |
| Number | Date | Country | |
|---|---|---|---|
| Parent | 09902809 | Jul 2001 | US |
| Child | 11381098 | US |
