Adding functionalities to pages by inheriting PublishingLayoutPage

Links (4/15/2007) « Steve Pietrek’s SharePoint Weblog

Links (4/15/2007) « Steve Pietrek’s SharePoint Weblog — Mon, 16 Apr 2007 03:33:34 GMT

PingBack from http://stevepietrekweblog.wordpress.com/2007/04/15/links-4152007/

re: Adding functionalities to pages by inheriting PublishingLayoutPage

koen — Wed, 25 Apr 2007 11:44:04 GMT

Hello Janne,

Thanks for that great article. But I'm still strugling with a couple of things :(. I inherited my page from the custom PublishingLayoutPageEx and it wend fine, All sharePoint words became in the right language exept the webparts?. All webparts stay in english despite what culture you using, is that normal? Or is a webparts rendered differently than the Page?

re: Adding functionalities to pages by inheriting PublishingLayoutPage

jannemattila — Thu, 26 Apr 2007 08:04:08 GMT

Hi koen!

Web parts don't differ in that sense that if their made using resources, then they work fine.

Here's an example:

writer.Write("Resource: " + HttpContext.GetGlobalResourceObject("Example","House").ToString() + "<br/>");

If you add that to you web part then you get example same text than in your page.

What is the exact web part your having problems with? It could be that it's using XSL Style Sheets and there is hardcoded text. Is that web part your own or OOB web part?

I hope my answer helped a little bit. Feel free to ping me if you didn't get the idea.

Anyways... Happy hacking!

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Koen — Thu, 26 Apr 2007 14:18:17 GMT

Hi janne,

First of all, thanks for the quick response :).

I'm not using a custom webpart. Instead I inserted a view of the common task list on the page and this view will always stay in english, nomatter what culture you set your thread to. Really strange.

If you go and look at the structure of the task list (feature at C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\FEATURES\TasksList\Tasks\Schema.xml) you can see it uses resources stored in C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\Resources.

I have installed multiple language packs on my SHarepoint server so that every resource file is there in different language but for some strange reason it refuses to use it :).

If I use variations, it will translate the tasklist in different languages but the problem is that I can use only one tasklist and that's wy I used your solution.

re: Adding functionalities to pages by inheriting PublishingLayoutPage

jannemattila — Fri, 27 Apr 2007 00:41:46 GMT

Hi Koen!

Thanks for asking because it was really nice to dig on this one. I like to solve problems and this was definately a nice one :-)

Okay.. I'll explain what I did.

1) I first verified your problem by creating same situation. And you're absolutely right! Web Parts don't actually change texts :(

2) Started digging with .resx files and DLLs with Reflector.

3) Noticed that behind the scenes there is CoreResources class that handles translations. And if you look at the following code, does this ring a bell on you:

static CoreResource()

{

_aIntl = Assembly.Load("Microsoft.SharePoint.intl, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c");

_SPRM = new ResourceManager("Microsoft.SharePoint", _aIntl);

_WebPartPageRM = new ResourceManager("Microsoft.SharePoint.WebPartPages.strings", _aIntl);

}

4) You start wondering why there is _WebPartPageRM (and is different from the other texts) and where are those text then.

5) Take Reflector and open "Microsoft.SharePoint.intl, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c". Under it there is Resources and of course: Microsoft.SharePoint.WebPartPages.strings.resources.

6) Search text that you know some web part page uses

7) You have found the place for your text.

Okay.. so now we have this "neutral" dll where are resources. But I don't have access to systems that has multiple languages installed, so I don't know that is that DLL available for different cultures.

I hope that this gives you the answer your looking for... If you can dig your system too and you could give me feedback that you have verified my idea.

Anyways... Happy hacking!

re: Adding functionalities to pages by inheriting PublishingLayoutPage

jannemattila — Fri, 27 Apr 2007 00:44:16 GMT

I just wanted to add a note for my previous comment: "Web Parts don't actually change texts". But of course your own web parts change languages if you use resources :-) Just to make this clear.

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Koen — Fri, 27 Apr 2007 18:52:47 GMT

Janne,

You are right, I have found the CoreResource en the resource DLL's.

In a multilingual environment, you have a dll for each language:

Microsoft.SharePoint.intl.dll -->

Microsoft.SharePoint.resources

Microsoft.SharePoint.WebPartPages.strings.resources

microsoft.sharepoint.intl.resources.dll Language Dutch) -->

Microsoft.SharePoint.nl.resources

Microsoft.SharePoint.WebPartPages.strings.nl.resources

microsoft.sharepoint.intl.resources.dll Language French) -->

Microsoft.SharePoint.fr.resources

Microsoft.SharePoint.WebPartPages.strings.fr.resources

When I look at the resource string of a common task list, for instance the Priority field, you have following schema:

<Field ID="{a8eb573e-9e11-481a-a8c9-1104a54b2fbd}"

Type="Choice"

Name="Priority"

DisplayName="$Resources:core,Priority;"

SourceID="http://schemas.microsoft.com/sharepoint/v3"

StaticName="Priority">

<CHOICE>$Resources:core,Priority_High;</CHOICE>

<CHOICE>$Resources:core,Priority_Normal;</CHOICE>

<CHOICE>$Resources:core,Priority_Low;</CHOICE>

</CHOICES>

<MAPPING Value="1">$Resources:core,Priority_High;</MAPPING>

<MAPPING Value="2">$Resources:core,Priority_Normal;</MAPPING>

<MAPPING Value="3">$Resources:core,Priority_Low;</MAPPING>

</MAPPINGS>

<Default>$Resources:core,Priority_Normal;</Default>

</Field>

So, when I search for Priority_High, Priority_Normal, Priority_Low, I found nothing in the resource files.

I can found it back in the resource file

C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\Resources\core.resx

C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\Resources\corecore.nl-nl.resx

C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\Resources\corecore.fr-fr.resx

Also, I have seen that, like you said, there is a clear difference between plain SharePoint and a sharepoint WebPartPage

internal static string GetString(CultureInfo culture, ResourceGroup rg, string name, params object[] values)

{

string text = null;

StringBuilder builder;

int num3;

switch (rg)

{

case ResourceGroup.SharePoint:

text = _SPRM.GetString(name, culture);

case ResourceGroup.WebPartPage:

text = _WebPartPageRM.GetString(name, culture);

}

So, I followed the trace from above in the listviewWebpart but so far I don't see it yet.

I keep you posted, I hope you will do it also

Regards,

Koen

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Andy H — Thu, 28 Jun 2007 16:52:32 GMT

Hi Janne

I'm having a few problems with this. Firstly I'm at the point where it's time to register in the GAC. Is it possible to register this Class Library in the bin folder of the web application (site collection) rather than in the GAC? I've tried placing the dll (which is strong named) into \Inetpub\wwwroot\wss\VirtualDirectories\MyApp\bin folder and putting the entry in the web.config with the correct details (including the PublicKeyToken) but I get the Parser Error you show above still.

We have been able to get our webparts working by doing the above.

I thought I'd try registering it in the GAC on the server, but my first hurdle was that the gacutil was for version 1.1 only and would not accept it. The admin control panels also only have the 1.1 .net configuration control panel. Obviously .net 2 is on there (as SP is running) but I've double checked IIS which confirms it is using 2.0.

I've copied up gacutil for 2.0 and it says it is registering it, but does not appear in the list (and I still get this parser error). Any ideas?

Preferably I'd like to get this class running from the web bin.

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Andy H — Thu, 28 Jun 2007 17:47:23 GMT

I've been able to get it into the GAC now, but I release the error I am getting is different to the one on this page. I get this error in all cases...

Parser Error

Description: An error occurred during the parsing of a resource required to service this request. Please review the following specific parse error details and modify your source file appropriately.

Parser Error Message: Could not load the assembly "..."

re: Adding functionalities to pages by inheriting PublishingLayoutPage

jannemattila — Fri, 29 Jun 2007 08:54:09 GMT

Hi Andy!

So now your're having the "Could not load the assembly" error? I think you get the error because it's not probably installed to the GAC. Did you use Visual Studio Command prompt and GACUTIL /i your_assembly_here? And did you verify that version number of gacutil is "Version 2.0.50727.42"? Or how did you install it to gac?

Because if it's installed to GAC properly and that "Inherits=..." part is also correctly set in page layout then this should be fine.

Please give comment if that didn't solve your problem.

Anyways... happy hacking!

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Andy H — Fri, 29 Jun 2007 11:06:11 GMT

Hi Janne, the server I am installing to was missing the v 2.0.5... gacutil but I copied a version of it to the server and used:

gacutil -i MyCompany.PublishingLayoutPageEx.dll

which reported it was OK. I did gacutil -l MyCompany.PublishingLayoutPageEx and it showed up.

In my layout page (I made a copy of Article Left and modified that) I changed the top to read:

<%@ Page language="C#" Inherits="MyCompany.PublishingLayoutPageEx,MyCompany,Version=1.0.0.0,Culture=neutral,PublicKeyToken=1294058909b4416a" %>

The PublicKeyToken is correct (checked with Net Reflector).

In VS2005 I have this:

using System;

using System.Collections.Generic;

using System.Text;

using System.Web.UI;

using Microsoft.SharePoint.Publishing;

using Microsoft.SharePoint;

namespace MyCompany

{

public class PublishingLayoutPageEx : PublishingLayoutPage

{

public PublishingLayoutPageEx() : base()

{

}

And I have added references to System.Web and the two sharepoint dll's.

My AssemblyInfo.cs properties show Assembly name: MyCompany.PublishingLayoutPageEx and Default namespace as MyCompany.

I am new to both SharePoint and .NET but the instructions on your blog are clear enough and I'm not sure what I might be missing or doing wrong. Even after an iisreset I get that error with "Could not load the assembly".

re: Adding functionalities to pages by inheriting PublishingLayoutPage

jannemattila — Fri, 29 Jun 2007 11:16:56 GMT

Hi Andy!

It seems that there is conflict with these two:

MyCompany.PublishingLayoutPageEx.dll

and

Inherits="MyCompany.PublishingLayoutPageEx,MyCompany,Version=1.0.0.0,...

I think the Inherits should be:

MyCompany.PublishingLayoutPageEx,MyCompany.PublishingLayoutPageEx,...

(just add ".PublishingLayoutPageEx")

That looks like the problem... But you're close the finish line already :-)

Anyways.. happy hacking!

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Andy H — Fri, 29 Jun 2007 11:38:37 GMT

Thank you so much Janne

I'm getting closer. I'm now getting "Parser Error Message: Could not load type" so at least it is being recognised now and I can go back over my previous steps to check its all set up correctly.

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Andy H — Fri, 29 Jun 2007 12:37:07 GMT

Got it more or less sorted now. For information on my last problem, that was caused by an error in case (Mycompany v MyCompany).

Thank you so much for the help, I wonder if I could ask one more question. In SharePoint designer, the copy of ArticleLeft.aspx I created is stating "Master Page error - The page has controls that require a Master Page reference, but none is specified. Attach a Master Page, or correct the problem in Code View."

Attach a Master Page is a link but does not do anything and Code View is a link and highlights my <@ Page line at the top.

I should add that currently my DLL sits in the sites bin folder and not the GAC as I originally wanted it just for my site collection and not anything else on the server, is the the problem or should I be looking elsewhere?

re: Adding functionalities to pages by inheriting PublishingLayoutPage

jannemattila — Fri, 29 Jun 2007 12:44:40 GMT

Hi Andy!

You can define the master page at the Page directive like this:

... MasterPageFile="~/_layouts/default.master" ...

After that SPD should be fine with it.

I think you can just deploy to your bin. I don't see any problems with that.

Anyways... happy hacking!

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Myo Thaw Tun — Mon, 16 Jul 2007 07:51:11 GMT

Dear Janne,

I want to publish the News articles without text formatting.

I mean I want to modify ArticleLeft.aspx PageLayout to display Left aligned image and text only.

MOSS users can make news entries with Image on the left template.

They may copy some news and texts from Internet and paste them into the content of news entry.

But there would be text formatting at that entries. What I need to do is to display only Image with text without formatting.

Is it possible to create new PageLayout to display like that? Can you give me some ideas how to do?

Please kindly advice me. I hope your reply.

Myo

Extend The PublishingLayoutPage Class - Create Your Own to Run Code in the 'Page'

Sezai's MOSS 2007 blog — Thu, 30 Aug 2007 18:22:11 GMT

This is powerful stuff, and thanks to this I can do a lot more powerful MOSS WCM custom development.

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Kristian — Wed, 19 Sep 2007 13:12:27 GMT

I was wondering if you had tried to do the masterpage change using a custom HttpModule? I have been trying to do it using the following code:

public class Hook : IHttpModule

{

public void Init(HttpApplication context)

{

context.PreRequestHandlerExecute += new EventHandler(context_PreRequestHandlerExecute);

}

void context_PreRequestHandlerExecute(object sender, EventArgs e)

{

Page page;

IHttpHandler handler = HttpContext.Current.Handler;

page = handler as Page;

if (page != null)

page.PreInit += new EventHandler(page_PreInit);

}

void page_PreInit(object sender, EventArgs e)

{

Page page = sender as Page;

if (page != null)

{

string strUrl = "/Docs/_catalogs/masterpage/";

SPWeb web = SPControl.GetContextSite(HttpContext.Current).OpenWeb();

SPUser user = web.CurrentUser;

if (user == null)

strUrl = "";

else

strUrl += "BlueBand.master";

if (strUrl.Length > 0)

page.MasterPageFile = strUrl;

}

public void Dispose()

{

}

I works like a charm on wss 3.0, but MOSS publishing pages just ignores it. The preInit event hook is set on the page, but it is never called. I'm all out of ideas, any comments would be greatly appreciated.

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Martin — Wed, 24 Oct 2007 10:47:58 GMT

Hello Janne,

I am interested in the code to change the PageLayout associated with a PublishingPage.

To my mind, the PublishingPage represents the data, and the PageLayout represents the view on that data.

Consequently the view should be selectable dynamically. I would expect to be able to place webparts on the PageLayout aspx page which connected to Field Values from the PublishingPage via FieldControls. Thus the overall content displayed on a Publishing page would include PublishingPage columns, and adhoc data from else where, via connected web parts. I would expect to control rights to the edit the web parts discretely from the rights to edit the columns of a PublishingPage via a PageLayout page (ie someone may be able to edit web parts, but not the PublishingPage data, and vice versa).

However I have two concerns over whether I am off track with these thoughts:

1) I not sure how to select the PageLayout dynamically at render time. The closest I have got is to derive from the TemplateRedirectionPage, and set the PublishingPage.Layout property in it's PreInit event (somehow).

2) An article "How to Upgrade an Area based on a Custom Site Definition" at says "Webpart associations are also based on the actual publishing page" I am not sure of the consequences of this.

I would be very interested to have your response to this.

Many Thanks

Martin

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Faizur — Sun, 04 Nov 2007 14:43:39 GMT

Kristian, did u find a solution to the problem? I am having the same issue

Don't miss Asp.net code with moss

On the MOSS Road — Mon, 19 Nov 2007 16:19:45 GMT

I found a great article Janne Mattila. discuses that if the layout page just inherit from Microsoft.SharePoint.Publishing.PublishingLayoutPage...

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Egholm — Thu, 10 Jan 2008 13:22:47 GMT

great article.....helped med a lot

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Mike — Tue, 19 Feb 2008 20:38:57 GMT

namespace Microsoft.MCS.Common

{

public class PublishingLayoutPageEx : PublishingLayoutPage

{

public PublishingLayoutPageEx()

: base()

{

}

I am getting bellow error " : base() " in this line

Could not load file or assembly 'Microsoft.SharePoint.Library, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c' or one of its dependencies. The system cannot find the file specified.

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Mike — Wed, 20 Feb 2008 18:14:57 GMT

PublishingLayoutPage vs. WebPartPage

U cannot always inherit from PublishingLayoutPage, If you are not using Default. Master

Read this article

http://www.msdner.net/dev-archive/117/328-1202-1177874.shtm

re: Adding functionalities to pages by inheriting PublishingLayoutPage

aaronnaas — Tue, 26 Feb 2008 23:47:27 GMT

Thanks for the tip on PublishingLayoutPage changing the MasterPageFile on OnPreInit(). See how I changed it back in my Page scope OnPreInit() override.

re: Adding functionalities to pages by inheriting PublishingLayoutPage

shareuser — Wed, 16 Apr 2008 20:51:25 GMT

Thanks for this article. very helpful.

Sorry, I have a basic question -- where do i get the class library project template from? do you mean any regular class? I am trying to understand, what would i need to start working on this.

Thanks in advance!

How We Did It - Australia National Native Title Tribunal website - advanced web content management

Microsoft SharePoint Products and Technologies Team Blog — Wed, 28 May 2008 04:45:46 GMT

Overview The National Native Title Tribunal of Australia assists people to resolve native title issues

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Alex Talarico — Tue, 10 Feb 2009 20:14:50 GMT

i couldnt get your Print trick to work. For one, the page (either master page or page layout) says that there is no suitable method to override for OnPreInit so I tried Page_PreInit instead. This didnt work on the master page and while it executed on the page layout it did not change my master page. Is there an update call missing? did you test your code?

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Alex Talarico — Tue, 10 Feb 2009 20:39:07 GMT

oops - it works, I just didnt read the first half of the article and jumped to the code :-/ sorry!

re: Adding functionalities to pages by inheriting PublishingLayoutPage

Sathya — Fri, 15 May 2009 05:42:10 GMT

Hi,

Please correct me if I am wrong. What I under stand from above is that this would work for custom webparts but not for OOB webparts.