Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SPMobileListNavigation Class

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

Namespace:  Microsoft.SharePoint.MobileControls
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class SPMobileListNavigation : SPMobileListTemplateSelector

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 SPMobileListNavigation 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 will take the following form.

The <RenderingTemplate> ID takes the following form.

IntendedListUse_ListTemplateID_PageType_ Navigation

The placeholders IntendedListUse, ListTemplateID, and PageType are defined in Mobile Page Rendering System.

The "Navigation" indicates that <RenderingTemplate> should apply to the footer part of the page.

Hence, the SPMobileListNavigation object for an announcements list view page on a mobile web site is the following.

Mobile_104_View_Navigation

Alternatively, it could be the following.

Mobile_Announcements_View_Navigation

The following excerpt from the MobileDefaultTemplates.ascx file (in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\CONTROLTEMPLATES) shows the markup that controls the rendering of footers when the page type is DeletePage. Notice that there are specific templates only for the Comments and Posts list types. All other list types use the Mobile_Default_DeletePage_Navigation <RenderingTemplate>.

<SharePoint:RenderingTemplate RunAt="Server" id="MobileDeleteNavigation">
  <Template>
    <SPMobile:SPMobileListNavigation RunAt="Server" />
  </Template>
</SharePoint:RenderingTemplate>
<SharePoint:RenderingTemplate RunAt="Server" id="Mobile_Default_DeletePage_Navigation">
  <Template>
    <SPMobile:SPMobileFormDigest RunAt="Server" />
    <SPMobile:SPMobileDeleteNavigation RunAt="Server" Text="<%$Resources:wss, mobile_button_delete_text%>" BreakAfter="false" />
    <SPMobile:SPMobileCancelNavigation RunAt="Server" Text="<%$Resources:wss, mobile_button_cancel_text%>" BreakAfter="true"  />
  </Template>
</SharePoint:RenderingTemplate>
<SharePoint:RenderingTemplate RunAt="Server" id="Mobile_Comments_DeletePage_Navigation">
  <Template>
    <SPMobile:SPMobileFormDigest RunAt="Server" />
    <SPMobile:SPMobileCommentsDeleteNavigation RunAt="Server" Text="<%$Resources:wss, mobile_button_delete_text%>" BreakAfter="false" />
    <SPMobile:SPMobileCommentsCancelNavigation RunAt="Server" Text="<%$Resources:wss, mobile_button_cancel_text%>" BreakAfter="true"  />
  </Template>
</SharePoint:RenderingTemplate>
<SharePoint:RenderingTemplate RunAt="Server" id="Mobile_Posts_DeletePage_Navigation">
  <Template>
    <SPMobile:SPMobileFormDigest RunAt="Server" />
    <SPMobile:SPMobilePostsDeleteNavigation RunAt="Server" Text="<%$Resources:wss, mobile_button_delete_text%>" BreakAfter="false" />
    <SPMobile:SPMobilePostsCancelNavigation RunAt="Server" Text="<%$Resources:wss, mobile_button_cancel_text%>" />
  </Template>
</SharePoint:RenderingTemplate>

Do not change MobileDefaultTemplates.ascx or GbwMobileDefaultTemplates.ascx. For any combination of page type and list type that does not already have a <RenderingTemplate> defined in MobileDefaultTemplates.ascx or GbwMobileDefaultTemplates.ascx, you can override the Mobile_Default_PageType_Navigation <RenderingTemplate> with the following method.

Create a custom *.ascx file in the ...\CONTROLTEMPLATES folder that contains a <RenderingTemplate> with the name Mobile_ListTemplateID_PageType_Navigation. Specify the Type or Name of a <ListTemplate Element (List Template)> in place of ListTemplateID, and specify a particular PageType. The latter must be one of the following: "DeletePage", "DispForm", "EditForm", "NewForm", or "View". Your custom <RenderingTemplate> then calls a combination of controls that differs from those used by Mobile_Default_PageType_Navigation to render the footer. (Otherwise the customization would be pointless.)

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

For more about customizing web page footers for built-in SharePoint Foundation page types other than home pages, see Walkthrough: Customizing a Mobile List View Page.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.