Partager via


SPMobileListTitle Class

Specifies the ID of the <RenderingTemplate> that is used when rendering the header area of a mobile page or form other than the home page.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.MobileControls.MobileControl
      Microsoft.SharePoint.MobileControls.SPMobileComponent
        Microsoft.SharePoint.MobileControls.SPMobileTemplateSelector
          Microsoft.SharePoint.MobileControls.SPMobileListTemplateSelector
            Microsoft.SharePoint.MobileControls.SPMobileListTitle

Namespace:  Microsoft.SharePoint.MobileControls
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
Public NotInheritable Class SPMobileListTitle _
    Inherits SPMobileListTemplateSelector

Dim instance As SPMobileListTitle
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
public sealed class SPMobileListTitle : SPMobileListTemplateSelector

Remarks

For an overview of the role of this class in the page rendering system for mobile devices, see Mobile Page Rendering System.

Do not call SPMobileListTitle in your code. It is documented to provide further understanding of how mobile Web pages are rendered and how the rendering can be customized.

The <RenderingTemplate> ID takes the following form.

Mobile_ListTemplateID_PageType_Title

The "Mobile" is a prefix that indicates that the <RenderingTemplate> is for mobile Web sites.

The "Title" indicates that <RenderingTemplate> should apply to the header part of the page.

The PageType is the type of page, such as View or NewForm. It is never HomePage. For the rendering of the title area of home pages, Windows SharePoint Services 3.0 uses SPMobileWebTitle.

The ListTemplateID is either the integer value of the Type attribute for the Collaborative Application Markup Language (CAML) <ListTemplate Element (List Template)> element or the value of the Name attribute. For example, the Type value for the announcements list template is 104. Hence, the SPMobileListTitle object for an announcements list view page on a mobile Web site is the following.

Mobile_104_View_Title

Alternatively, it could be the following.

Mobile_Announcements_View_Title

As it happens, when Windows SharePoint Services 3.0 is installed, there is initially no defined <RenderingTemplate> (for mobile page headers) for any specific list type, not even the built-in types. All pages use the Mobile_Default_PageType_Title <RenderingTemplate>. For example, as the following excerpt from the MobileDefaultTemplates.ascx file (in C:\\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\CONTROLTEMPLATES) shows, when the page type is View, the Mobile_Default_View_Title <RenderingTemplate> is used regardless of the Web site type. (The Mobile_Default_View_Title template calls SPMobileListTitleControl to render a title.)

<SharePoint:RenderingTemplate RunAt="Server" ID="MobileViewTitle">
  <Template>
    <SPMobile:SPMobileListTitle RunAt="Server" />
  </Template>
</SharePoint:RenderingTemplate>
<SharePoint:RenderingTemplate RunAt="Server" 
  ID="Mobile_Default_View_Title">
  <Template>
    <SPMobile:SPMobileListTitleControl RunAt="Server" />
  </Template>
</SharePoint:RenderingTemplate>

Do not change MobileDefaultTemplates.ascx. To customize the rendering of the header for a particular page type (other than the home page or a custom page) of a particular Web site type, create a custom .aspx file in the ...\CONTROLTEMPLATES folder that contains a <RenderingTemplate> with the name Mobile_ListTemplateID_PageType_Title. Specify the ID (or Name) of a <ListTemplate Element (List Template)> in place of ListTemplateID. Also specify a particular PageType. The latter must be one of the following: "DeletePage", "DispForm", "EditForm", "NewForm", or "View". Your custom <RenderingTemplate> then calls an alternative to SPMobileListTitleControl to render the header.

The runtime automatically gives preference to your custom <RenderingTemplate> over the Mobile_Default_PageType_Title <RenderingTemplate> in MobileDefaultTemplates.ascx.

For more about customizing Web page titles for built-in Windows SharePoint Services 3.0 page types other than home pages, see Walkthrough: Customizing a Mobile List View Page.

For title rendering on custom page types, see SPMobilePageTitle.

Thread Safety

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

See Also

Reference

SPMobileListTitle Members

Microsoft.SharePoint.MobileControls Namespace

SPMoblePageTitle

Other Resources

Mobile Page Rendering System

Walkthrough: Customizing a Mobile List View Page