SPMobileListIterator.DefaultTemplateName Property

NOTE: This API is now obsolete.

Gets the name of the default template for the list of lists.

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

Syntax

'Declaration
<ObsoleteAttribute("Do not use this class since it is deprecated. Use SPMobileGenericListIterator instead")> _
Public Overrides ReadOnly Property DefaultTemplateName As String
    Get
'Usage
Dim instance As SPMobileListIterator
Dim value As String

value = instance.DefaultTemplateName
[ObsoleteAttribute("Do not use this class since it is deprecated. Use SPMobileGenericListIterator instead")]
public override string DefaultTemplateName { get; }

Property Value

Type: System.String
A String that represents the name of the default template for the list of all lists on the mobile site.

Remarks

In SharePoint Foundation this property always returns "MobileListIterator". This is the value of the ID attribute of a <RenderingTemplate> element in the file MobileDefaultTemplates.ascx or GbwMobileDefaultTemplates.ascx, which is located in the directory %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\CONTROLTEMPLATES.

You must not modify MobileDefaultTemplates.ascx or GbwMobileDefaultTemplates.ascx. To customize the rendering of this control, create another <RenderingTemplate> element in a new .ascx file in the ...\CONTROLTEMPLATES folder identified earlier. Give your new <RenderingTemplate> element an ID value that is descriptive but likely to be unique. For example, you could add your company's name to the end of the ID, such as "MobileListIteratorMyCompanyInc". Then derive a new class from SPMobileComponent, (the same parent as SPMobileListIterator) and override its DefaultTemplateName property so that it returns your custom ID.

See Also

Reference

SPMobileListIterator Class

SPMobileListIterator Members

Microsoft.SharePoint.MobileControls Namespace