随笔 - 175  文章 - 1 评论 - 2378 trackbacks - 136

修改WSS的控件的RenderingTemplate,可以灵活的控制表单页面的显示。
以前写过几篇相关的文章:
WSS3.0开发--页面定制(1)--修改列表的表单页面
WSS页面定制系列(2)---定制单个列表的表单页面
WSS页面定制系列(3)---重写表单的保存逻辑
WSS页面定制系列(4)--利用SmartForm和用户控件定制表单页面

以上几篇提到了RenderingTemplate的简单修改方法,貌似很多朋友仍然不能掌握具体的方法,就再来一篇吧。

WSS里有一个类TemplateBasedControl从这个类继承下来,控件就具有了加载模板的功能。
看一下这个类的方法:
public class TemplateBasedControl : SPControl, INamingContainer
{
    // Methods
    public TemplateBasedControl();
    [SharePointPermission(SecurityAction.Demand, ObjectModel
=true)]
    
protected override void CreateChildControls();
    
public static TemplateBasedControl GetParentTemplateBasedControl(Control control);
    [SharePointPermission(SecurityAction.Demand, ObjectModel
=true)]
    
protected override void OnLoad(EventArgs e);
    [SharePointPermission(SecurityAction.Demand, ObjectModel
=true)]
    
protected override void Render(HtmlTextWriter output);

    
// Properties
    [TemplateContainer(typeof(TemplateContainer))]
    
public ITemplate AlternateTemplate { getset; }
    
public string AlternateTemplateName { getset; }
    
public override ControlCollection Controls { [SharePointPermission(SecurityAction.Demand, ObjectModel=true)] get; }
    
protected virtual ITemplate ControlTemplate { get; }
    [TemplateContainer(
typeof(TemplateContainer)), PersistenceMode(PersistenceMode.InnerProperty)]
    
public ITemplate CustomAlternateTemplate { getset; }
    [TemplateContainer(
typeof(TemplateBasedControl)), PersistenceMode(PersistenceMode.InnerProperty)]
    
public ITemplate CustomTemplate { getset; }
    
protected virtual string DefaultAlternateTemplateName { get; }
    
protected virtual string DefaultTemplateName { get; }
    
public SPContext RenderContext { getset; }
    [TemplateContainer(
typeof(TemplateBasedControl))]
    
public ITemplate Template { getset; }
    
public virtual TemplateContainer TemplateContainer { get; }
    
public string TemplateName { getset; }
    
protected TemplateOverride TemplateOverride { getset; }
    
public virtual SPWeb Web { get; }
}

注意两个重要的属性:DefaultTemplateName 和TemplateName,这两个属性配置了控件的默认模板和自定义模板。若没有指定TemplateName,则TemplateName跟DefaultTemplateName一致,见如下代码:
public string TemplateName
{
    
get
    
{
        
if (this.m_templateName == null)
        
{
            
this.m_templateName = this.DefaultTemplateName;
        }

        
return this.m_templateName;
    }

    
set
    
{
        
this.m_templateName = value;
    }

}


在系统的默认模板文件(Defaulttemplate.ascx)中,很多控件都是从TemplateBasedControl继承的,应此他们具有加载模板的能力,很多情况下,一个模板控件还会加载其他的模板,模板中还会有模板控件,于是就形成了一个模板套模板的结构。
系统的模板控件在设计的时候,一般只会指定DefaultTemplateName,这样,我们就可以通过修改TemplateName来替换默认模板。
ListFieldIterator控件,她只是重载了DefaultTemplateName属性:
protected override string DefaultTemplateName
{
    
get
    
{
        
return "ListFieldIterator";
    }

}


表单页面模板一般为LitstForm ,如下:
ListForm

LitstForm 模板中嵌入了ListFieldIterator控件,这个控件遍历生成所有的字段控件,ListFieldIterator控件的默认模板是ListFieldIterator,如下:
<SharePoint:RenderingTemplate ID="ListFieldIterator" runat="server">
    
<Template>
        
<TR><SharePoint:CompositeField runat="server"/></TR>
    
</Template>
</SharePoint:RenderingTemplate>
这个模板中又嵌入了CompositeField控件,CompositeField控件的默认模板是CompositeField,内容如下: 

<SharePoint:RenderingTemplate ID="CompositeField" runat="server">
    
<Template>
        
<TD nowrap="true" valign="top" width="190px" class="ms-formlabel"><H3 class="ms-standardheader"><SharePoint:FieldLabel runat="server"/></H3></TD>
        
<TD valign="top" class="ms-formbody" width="400px">
        
<!-- FieldName="<SharePoint:FieldProperty PropertyName="Title" runat="server"/>"
             FieldInternalName="<SharePoint:FieldProperty PropertyName="InternalName" runat="server"/>"
             FieldType="SPField<SharePoint:FieldProperty PropertyName="Type" runat="server"/>"
          
-->
            
<SharePoint:FormField runat="server"/>
            
<SharePoint:FieldDescription runat="server"/>
            
<SharePoint:AppendOnlyHistory runat="server"/>
        
</TD>
    
</Template>
</SharePoint:RenderingTemplate>

如果要全面定制一个表单页面,需要修改以上的所有模板。
下面,演示一下如何将一个表单定制成如下样式:

新建一个模板文件:
TestTemplates.ascx,敲入一下代码:
<%@ Control Language="C#"   AutoEventWireup="false" %>
<%@Assembly Name="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@Register TagPrefix="SharePoint" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" namespace="Microsoft.SharePoint.WebControls"%>
<%@Register TagPrefix="SPHttpUtility" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" namespace="Microsoft.SharePoint.Utilities"%>
<%@ Register TagPrefix="wssuc" TagName="ToolBar" src="~/_controltemplates/ToolBar.ascx" %>
<%@ Register TagPrefix="wssuc" TagName="ToolBarButton" src="~/_controltemplates/ToolBarButton.ascx" %>
<SharePoint:RenderingTemplate ID="ListForm" runat="server">
    
<Template>
        
<SPAN id='part1'>
            
<SharePoint:InformationBar runat="server"/>
            
            
<SharePoint:FormToolBar runat="server"/>

<div>
<SharePoint:ListFieldIterator runat="server" TemplateName="ListFieldIterator2" />
</div>

            
<TABLE class="ms-formtable" style="margin-top: 8px;" border=0 cellpadding=0 cellspacing=0 width=100%>

            
<SharePoint:ChangeContentType runat="server"/>
            
<SharePoint:FolderFormFields runat="server"/>
            
            
<SharePoint:ApprovalStatus runat="server"/>
            
<SharePoint:FormComponent TemplateName="AttachmentRows" runat="server"/>
            
</TABLE>
            
<table cellpadding=0 cellspacing=0 width=100%><tr><td class="ms-formline"><IMG SRC="/_layouts/images/blank.gif" width=1 height=1 alt=""></td></tr></table>
            
<TABLE cellpadding=0 cellspacing=0 width=100% style="padding-top: 7px"><tr><td width=100%>
            
<SharePoint:ItemHiddenVersion runat="server"/>
            
<SharePoint:ParentInformationField runat="server"/>
            
<SharePoint:InitContentType runat="server"/>
            
<wssuc:ToolBar CssClass="ms-formtoolbar" id="toolBarTbl" RightButtonSeparator="&nbsp;" runat="server">
                    
<Template_Buttons>
                        
<SharePoint:CreatedModifiedInfo runat="server"/>
                    
</Template_Buttons>
                    
<Template_RightButtons>
                        
<SharePoint:SaveButton runat="server"/>
                        
<SharePoint:GoBackButton runat="server"/>
                    
</Template_RightButtons>
            
</wssuc:ToolBar>
            
</td></tr></TABLE>
        
</SPAN>
        
<SharePoint:AttachmentUpload runat="server"/>
    
</Template>
</SharePoint:RenderingTemplate>

<SharePoint:RenderingTemplate ID="ListFieldIterator2" runat="server">
    
<Template>
        
<SharePoint:CompositeField runat="server" TemplateName="CompositeField2"/>
    
</Template>
</SharePoint:RenderingTemplate>

<SharePoint:RenderingTemplate ID="CompositeField2" runat="server">
    
<Template>

        
<H3 class="ms-standardheader"><SharePoint:FieldLabel runat="server"/></H3>
         
<br/>
        
<!-- FieldName="<SharePoint:FieldProperty PropertyName="Title" runat="server"/>"
             FieldInternalName="<SharePoint:FieldProperty PropertyName="InternalName" runat="server"/>"
             FieldType="SPField<SharePoint:FieldProperty PropertyName="Type" runat="server"/>"
          
-->
        
<SharePoint:FormField runat="server"/>
        
<SharePoint:FieldDescription runat="server"/>
        
<SharePoint:AppendOnlyHistory runat="server"/>
         
<br/>
    
</Template>
</SharePoint:RenderingTemplate>

以上代码修改了ListFieldIterator,CompositeField两个控件的默认模板。

注意:这个修改几乎对所有的列表表单起作用,因为直接覆盖了ID为ListForm的模板。
若只需要对某个表单起作用,需要将第一个模板的ID改掉,不能跟系统已有模本ID重复,然后按照本文开头罗列的几篇文章中的方法,或者用SPD修改ListFormWebPart的模板名,或者用SmartForm加载新的模板。

文件保存后,重启IIS即可看到效果。

posted on 2008-04-09 00:20  jianyi  阅读(3005)  评论(10编辑  收藏