Export (0) Print
Expand All

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.

System.Object
  System.Web.UI.MobileControls.Adapters.ControlAdapter
    System.Web.UI.MobileControls.Adapters.XhtmlAdapters.XhtmlControlAdapter
      More...

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

[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.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class XhtmlControlAdapter : ControlAdapter

The XhtmlControlAdapter type exposes the following members.

  NameDescription
Public methodXhtmlControlAdapterCreates 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.
Top

  NameDescription
Public propertyControlReturns 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.)
Protected propertyCssLocationIndicates 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.
Public propertyDeviceReturns 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.)
Protected propertyDocumentTypeIndicates 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.
Public propertyItemWeightAccesses 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.)
Public propertyPageReturns 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.)
Protected propertyPageAdapterGets 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.
Protected propertySecondaryUIModeGets 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.
Public propertyStyleReturns 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.)
Protected propertyStyleSheetLocationAttributeValueGets 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.
Protected propertyStyleSheetStorageApplicationSettingGets 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.
Public propertyVisibleWeightGets 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.)
Top

  NameDescription
Protected methodCalculateOptimumPageWeightDetermines 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.)
Protected methodClearPendingBreakIfDeviceBreaksOnBlockLevelClears 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.
Protected methodConditionalClearCachedEndTagClears 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.
Protected methodConditionalClearPendingBreakClears 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.
Protected methodConditionalEnterFormatBegins 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.
Protected methodConditionalEnterLayoutBegins 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.
Protected methodConditionalEnterStyle(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.
Protected methodConditionalEnterStyle(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.
Protected methodConditionalExitFormatEnds 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.
Protected methodConditionalExitLayoutEnds 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.
Protected methodConditionalExitStyleEnds 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.
Protected methodConditionalPopPhysicalCssClassRemoves 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.
Protected methodConditionalRenderClassAttributePuts 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.
Protected methodConditionalRenderClosingDivElementRenders 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.
Protected methodConditionalRenderClosingSpanElementRenders 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.
Protected methodConditionalRenderCustomAttribute(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.
Protected methodConditionalRenderCustomAttribute(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.
Protected methodConditionalRenderOpeningDivElementRenders 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.
Protected methodConditionalRenderOpeningSpanElementRenders 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.
Protected methodConditionalSetPendingBreakSets 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.
Protected methodConditionalSetPendingBreakAfterInlineSets 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.
Public methodCreateTemplatedUICalled 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.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodExitSecondaryUIModeExits 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.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGetCustomAttributeValue(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.
Protected methodGetCustomAttributeValue(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.
Protected methodGetDefaultLabelReturns 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.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHandlePostBackEventReturns 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.)
Public methodLoadAdapterStateLoads 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).)
Public methodLoadPostDataReturns 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.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnInitCalled 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.)
Public methodOnLoadLoads 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.)
Public methodOnPreRenderCalled 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.)
Public methodOnUnloadUnloads 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.)
Protected methodPreprocessQueryStringGets 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.
Public methodRender(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).)
Public methodRender(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.
Protected methodRenderAsHiddenInputFieldRenders 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.
Protected methodRenderBeginLink(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.
Protected methodRenderBeginLink(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.
Protected methodRenderBeginLink(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.
Protected methodRenderChildrenRenders 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.)
Protected methodRenderClosingListTagRenders 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.
Protected methodRenderEndLinkRenders 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.
Protected methodRenderOffPageVariablesRenders 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.
Protected methodRenderOpeningListTagRenders 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.
Protected methodRenderPostBackEventAsAnchor(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.
Protected methodRenderPostBackEventAsAnchor(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.
Protected methodRenderPostBackEventAsAnchor(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.
Public methodSaveAdapterStateSaves 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().)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Protected fieldStatic memberNotSecondaryUIA 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.
Top

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Obsolete (compiler warning) in 4.5.2
Obsolete (compiler warning) in 4.5.1
Obsolete (compiler warning) in 4.5
Obsolete (compiler warning) in 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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

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
Show:
© 2014 Microsoft