SPMobilePageTitle Class

Specifies the ID of the entry point <RenderingTemplate> that is used when rendering the title of a mobile Web page.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.MobileControls.MobileControl
      Microsoft.SharePoint.MobileControls.SPMobileComponent
        Microsoft.SharePoint.MobileControls.SPMobilePageTitle

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

Syntax

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

Dim instance As SPMobilePageTitle

[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public sealed class SPMobilePageTitle : SPMobileComponent

Remarks

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

An SPMobilePageTitle object appears in the <HeaderTemplate> element of a mobile Web page. It specifies the entry point into the relevant portion of the MobileDefaultTemplates.aspx file located in C:\\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\CONTROLTEMPLATES.

If the page type is HomePage, the DefaultTemplateName property holds the ID of the <RenderingTemplate>. For all other page types, the TemplateName property holds the ID of the <RenderingTemplate>.

Examples

The following excerpt from mbllists.aspx, the default home page for mobile Web sites in Windows SharePoint Services, shows a SPMobilePageTitle in use.

<!-- Page declaration and other matter omitted -->
<SPMobile:SPMobileForm RunAt="Server" PageType="HomePage" Paginate="true">
  <DeviceSpecific>
    <Choice>
      <HeaderTemplate>
        <SPMobile:SPMobileControlContainer RunAt="Server" Weightless="true">
          <SPMobile:SPMobilePageTitle RunAt="Server" />
          <SPMobile:SPMobileComponent RunAt="Server" TemplateName="MobileDefaultSeparator" />
        </SPMobile:SPMobileControlContainer>
      </HeaderTemplate>
      <!-- matter omitted -->
    </Choice>
  </DeviceSpecific>
  <SPMobile:SPMobilePageContents RunAt="Server" />
</SPMobile:SPMobileForm>

Because the page type is a home page, the value of the DefaultTemplateName property, "MobileHomePageTitle", identifies the entry point <RenderingTemplate> in MobileDefaultTemplates.aspx. The following excerpt from that file shows that the MobileHomePageTitle <RenderingTemplate> calls a SPMobileWebTitle control. It, in turn, identifies a more specific <RenderingTemplate> ID: Mobile_WebSiteType_HomePage_Title, where WebSiteType is the value of the Name or ID attribute of the Collaborative Application Markup Language (CAML) <Template Element (Site)> element (of the SharePoint WEBTEMP.XML file) for the current type of Web site. For example, the Name value for the blog site definition is "BLOG". Hence, the SPMobileWebTitle object defines the following <RenderingTemplate> ID for a mobile blog home page.

Mobile_BLOG_HomePage_Title

(For a custom site definition, WebSiteType is the value of the ID attribute of the <Template Element (Site)> element, not the Name attribute.)

If the runtime does not find a <RenderingTemplate> with that name in an .aspx file in the ...\CONTROLTEMPLATES folder, it uses the <RenderingTemplate> named Mobile_Default_HomePage_Title. That <RenderingTemplate>, in turn, calls a SPMobileWeb control which simply renders the title of the Web site.

<SharePoint:RenderingTemplate RunAt="Server" ID="MobileHomePageTitle">
  <Template>
    <SPMobile:SPMobileWebTitle RunAt="Server" />
  </Template>
</SharePoint:RenderingTemplate>
<SharePoint:RenderingTemplate RunAt="Server" ID="Mobile_Default_HomePage_Title">
  <Template>
    <SPMobile:SPMobileWeb RunAt="Server" />
  </Template>
</SharePoint:RenderingTemplate>

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

SPMobilePageTitle Members

Microsoft.SharePoint.MobileControls Namespace

Other Resources

Mobile Page Rendering System