XhtmlControlAdapter Class

XhtmlControlAdapter Class

 
Note: This API is now obsolete.

Provides a default control adapter for rendering mobile controls in XHTML markup. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

Namespace:   System.Web.UI.MobileControls.Adapters.XhtmlAdapters
Assembly:  System.Web.Mobile (in System.Web.Mobile.dll)

System.Object
  System.Web.UI.MobileControls.Adapters.ControlAdapter
    System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlControlAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlCalendarAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlCommandAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlFormAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlImageAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlLabelAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlLinkAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlListAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlLiteralTextAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlObjectListAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlPageAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlPanelAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlPhoneCallAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlSelectionListAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlTextBoxAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlTextViewAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlValidationSummaryAdapter
      System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlValidatorAdapter

[ObsoleteAttribute("The System.Web.Mobile.dll assembly has been deprecated and should no longer be used. For information about how to develop ASP.NET mobile applications, see http://go.microsoft.com/fwlink/?LinkId=157231.")]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, 
	Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, 
	Level = AspNetHostingPermissionLevel.Minimal)]
public class XhtmlControlAdapter : ControlAdapter

NameDescription
System_CAPS_pubmethodXhtmlControlAdapter()

Creates a new instance of the XhtmlControlAdapter class. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

NameDescription
System_CAPS_pubpropertyControl

Returns a strongly typed reference to the associated control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_protpropertyCssLocation

Indicates whether the style sheet is located as an external physical file, is internal to the current page, is stored in the current session state, or is stored in the application cache. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_pubpropertyDevice

Returns the device capabilities object associated with the request. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_protpropertyDocumentType

Indicates the type of XHTML markup used to render the current document. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_pubpropertyItemWeight

Accesses the approximate weight of a single item in the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_pubpropertyPage

Returns the page associated with the device adapter. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_protpropertyPageAdapter

Gets the page adapter for the page on which the associated control resides. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protpropertySecondaryUIMode

Gets the current secondary UI mode. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_pubpropertyStyle

Returns the style object associated with the control to which the device adapter is attached. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_protpropertyStyleSheetLocationAttributeValue

Gets the value of the CssLocation attribute, if it exists, from the form in which it is contained. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protpropertyStyleSheetStorageApplicationSetting

Gets the value of the XhtmlCssState configuration setting in the appSettings section of the Web.config file. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_pubpropertyVisibleWeight

Gets or sets the approximate weight of the control, in characters. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

NameDescription
System_CAPS_protmethodCalculateOptimumPageWeight(Int32)

Determines the optimum page weight for the device. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_protmethodClearPendingBreakIfDeviceBreaksOnBlockLevel(XhtmlMobileTextWriter)

Clears a pending break if the target device breaks on block elements. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalClearCachedEndTag(XhtmlMobileTextWriter, String)

Clears the given text writer's current end tag if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalClearPendingBreak(XhtmlMobileTextWriter)

Clears a pending break in the target device if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalEnterFormat(XhtmlMobileTextWriter, Style)

Begins a section with the opening tag and attributes that implement the formats of the specified style, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalEnterLayout(XhtmlMobileTextWriter, Style)

Begins a section with the opening tag and attributes that implement the layout of the specified style, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalEnterStyle(XhtmlMobileTextWriter, Style)

Writes the opening tag for a <span> section, along with attributes that implement the layout and character formatting of the specified style, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalEnterStyle(XhtmlMobileTextWriter, Style, String)

Writes the opening tag of the specified element, along with attributes that implement the layout and character formatting of the specified style, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalExitFormat(XhtmlMobileTextWriter, Style)

Ends a block that has been using the character formatting from a specified style, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalExitLayout(XhtmlMobileTextWriter, Style)

Ends a block that has been using the layout formatting from a specified style, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalExitStyle(XhtmlMobileTextWriter, Style)

Ends a </span> element that has been using the layout and character formatting from a specified style, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalPopPhysicalCssClass(XhtmlMobileTextWriter)

Removes the current cascading style sheet class name from the XhtmlMobileTextWriter object, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalRenderClassAttribute(XhtmlMobileTextWriter)

Puts a class name attribute on the next element to be rendered, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalRenderClosingDivElement(XhtmlMobileTextWriter)

Renders a closing </div> tag if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalRenderClosingSpanElement(XhtmlMobileTextWriter)

Renders a closing </span> element if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalRenderCustomAttribute(XhtmlMobileTextWriter, String)

Gets the value of the attribute with the specified name from the associated control and renders it on the next element with the specified name if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalRenderCustomAttribute(XhtmlMobileTextWriter, String, String)

Includes a custom attribute with the specified name and value in the next element to be rendered, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalRenderOpeningDivElement(XhtmlMobileTextWriter)

Renders an opening tag for a <div> element if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalRenderOpeningSpanElement(XhtmlMobileTextWriter)

Renders an opening tag for a <span> element, if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalSetPendingBreak(XhtmlMobileTextWriter)

Sets a pending break if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodConditionalSetPendingBreakAfterInline(XhtmlMobileTextWriter)

Sets a pending break after inline elements if certain conditions are met. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_pubmethodCreateTemplatedUI(Boolean)

Called by a control to create a templated user interface (UI). This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodExitSecondaryUIMode()

Exits any secondary UI mode for the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodGetCustomAttributeValue(MobileControl, String)

Gets the value of the specified attribute from a given control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodGetCustomAttributeValue(String)

Gets the value of the specified attribute from the markup of the associated control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodGetDefaultLabel(Int32)

Returns the localized default string for the label control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodHandlePostBackEvent(String)

Returns true if the event was handled. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_pubmethodLoadAdapterState(Object)

Loads view state data specific to this adapter. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Overrides ControlAdapter.LoadAdapterState(Object).)

System_CAPS_pubmethodLoadPostData(String, NameValueCollection, Object, Boolean)

Returns true if the adapter handles loading the post data. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodOnInit(EventArgs)

Called after an object, such as a form or a page, is initialized. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_pubmethodOnLoad(EventArgs)

Loads data that pertains to a control, a page, or a device adapter. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_pubmethodOnPreRender(EventArgs)

Called by the control's OnPreRender method, to perform adapter-specific work prior to rendering. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_pubmethodOnUnload(EventArgs)

Unloads data that pertains to a control, a page, or a device adapter. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_protmethodPreprocessQueryString(String)

Gets the portion of the given query string that contains parameters for processing the request. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_pubmethodRender(HtmlTextWriter)

Displays the associated control and all of its child controls on the client. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Overrides ControlAdapter.Render(HtmlTextWriter).)

System_CAPS_pubmethodRender(XhtmlMobileTextWriter)

Displays the associated control and all of its child controls on the client. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderAsHiddenInputField(XhtmlMobileTextWriter)

Renders hidden field text for a control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderBeginLink(XhtmlMobileTextWriter, String)

Renders the opening tag of a link using the given XhtmlMobileTextWriter and target. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderBeginLink(XhtmlMobileTextWriter, String, String, Style, String)

Renders the opening tag of a link using the given XhtmlMobileTextWriter and target, as well as the given styles or the given cascading style sheet class name. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderBeginLink(XhtmlMobileTextWriter, String, String, Style, String, String)

Renders the opening tag of a link using the given XhtmlMobileTextWriter and target, as well as either the given styles or the given cascading style sheet class name, the access key, and the title text. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderChildren(HtmlTextWriter)

Renders children of the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Inherited from ControlAdapter.)

System_CAPS_protmethodRenderClosingListTag(XhtmlMobileTextWriter, String)

Renders a closing tag for a specified list element. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderEndLink(XhtmlMobileTextWriter)

Renders a closing tag (</a>) for a link element. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderOffPageVariables(XhtmlMobileTextWriter, Control, Int32)

Renders hidden postback variables for child controls that are not visible due to pagination or secondary UI. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderOpeningListTag(XhtmlMobileTextWriter, String)

Renders an opening tag for the specified tag name. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderPostBackEventAsAnchor(XhtmlMobileTextWriter, String, String)

Renders a postback event as a link with the specified argument and text. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderPostBackEventAsAnchor(XhtmlMobileTextWriter, String, String, String)

Renders a postback event as a link with the specified argument, text, and access key. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_protmethodRenderPostBackEventAsAnchor(XhtmlMobileTextWriter, String, String, String, Style, String)

Renders a postback event as a link with the specified argument, text, and access key, as well as the specified styles or the specified cascading style sheet class name. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

System_CAPS_pubmethodSaveAdapterState()

Saves view-state data specific to this adapter. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.(Overrides ControlAdapter.SaveAdapterState().)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_protfieldSystem_CAPS_staticNotSecondaryUI

A value returned by the SecondaryUIMode property, indicating that the adapter is not currently in secondary UI mode. This API is obsolete. For information about how to develop ASP.NET mobile applications, see the www.asp.net/mobile Web site.

This class provides a base mobile control adapter that renders a control and each of its children in XHTML markup for mobile devices. It also provides helper methods and common properties for derived XHTML mobile control adapters.

Control adapters are components that override certain Control class methods and events to allow browser-specific or markup-specific handling. Much of the adaptability in rendering behavior is encapsulated in the XhtmlTextWriter class. If you are considering whether to build your own control adapter, keep in mind that a single adapter can be used to override a number of browser class behaviors. Alternatively, by including the desired adaptability in a class derived from the XhtmlMobileTextWriter class, you might eliminate the need to use a control adapter.

An adapter for a specific control class applies to all controls that inherit from that class, unless more specialized adapters are present. For example, the XhtmlValidatorAdapter class is used to validate all mobile controls for devices that require or can display XHTML markup.

During processing, the .NET Framework intercepts calls to the methods of a control that are specific to the current target. If a control adapter is associated with the control, the .NET Framework calls the associated adapter methods.

Some properties of a control govern the way it displays across multiple secondary pages for a mobile device. These page are collectively known as secondary UI. The SecondaryUIMode property can be used to define which page will be displayed. The ExitSecondaryUIMode method can be used to remove any secondary UI settings.

Notes to Inheritors:

When you inherit from the XhtmlControlAdapter class, name your adapter for a given control type and markup language in the pattern MarkupControlTypeAdapter (for example, XhtmlTextBoxAdapter). Adapters for a control that provides XHTML markup should be implemented in the System.Web.UI.MobileControls.Adapters.XhtmlAdapters namespace.

Any specialized adapters should be defined for the specialized control under each of the device nodes in the configuration .browser files.

A properly implemented control should not assume that an adapter is attached, or that the attached adapter implements a specific interface. Instead, it should check for these conditions.

A number of conditional rendering methods allow for such conditions as secondary UI and for display devices that require line breaks after every block or after every inline control. Examples of these conditional methods are ConditionalSetPendingBreak and ConditionalEnterLayout. These methods work for a given device regardless of the control being rendered. It is unlikely you would need to override these methods when creating a new control adapter based on this class. At a minimum, you would need to override the Render methods.

Device filtering is required to use a specific adapter for a server control. For more information about device filtering, see Architectural Overview of Adaptive Control Behavior and ASP.NET Device Filtering Overview.

AspNetHostingPermission

for operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.

AspNetHostingPermission

for operating in a hosted environment. Demand value: InheritanceDemand; Permission value: Minimal.

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft