Communardo Software GmbH, Kleiststraße 10 a, D-01129 Dresden
0800 1 255 255

Funktionalere SharePoint-Seiten mit Hilfe von WPSC erstellen

Mit Hilfe von Web Part Page Service Component – kurz WPSC – kön­nen recht ein­fach zusätz­li­che Funktionalitäten ein­ge­bun­den wer­den. WPSC ist ein Satz von JavaScript-Funktionen erlaubt, dass z.B. Webparts unter­ein­an­der, mit SharePoint und mit dem Benutzer interagieren.

Im Folgenden möchte ich anhand des Beispiels von Woody Windishman kurz im Ansatz zei­gen, wel­che Möglichkeiten sich bieten.

Oft erwar­ten Benutzer von Webanwendungen die glei­chen Features, die sie auch von Desktop-Anwendungen schon ken­nen. Ein in Desktopanwendungen sehr tri­via­les und leicht zu imple­men­tie­ren­des Beispiel – wie Aufruf einer kon­text­sen­si­ti­ven Hilfe bie Druck auf F1 – gestal­tet sich im Web schon schwie­ri­ger. Hier kön­nen WPSC eine Brücke schlagen.

Wie rea­li­siert man das Ganze nun? Das Prinzip ist recht ein­fach und in zwei simp­len Schritten erklärt:

  1. Man erzeugt eine JavaScript-Funktion, die in einem neuen Fenster die Hilfe-HTML-Seite öffnet.
  2. Man regis­triert diese Funktion für den gewünsch­ten Event.

Soweit die Theorie – nun zur Praxis:

Gehen wir davon aus, dass bereits eine Hilfeseite exis­tiert – im Beispiel die Seite AppHelp.aspx in der Wiki-Bibliothek HelpWiki. Weiterhin gehen wir davon aus, dass eine WebPart-Page exis­tiert, für die Kontexthilfe ange­bo­ten wer­den soll.

Nun soll das JavaScript zum Aufruf der Hilfeseite inte­griert wer­den. Das geht recht ein­fach mit einem Content-Editor-Webpart durch­ge­führt wer­den. Aus die­sem Grund öff­nen wir die Seite im Design-Mode ("Site Actions" -> "Edit Page") und fügen einen Content-Editor-Webpart hinzu. Unter "Modify Shared Web Part" muss nun der Source Editor geöff­net und fol­gen­des JavaSript hin­zu­ge­fügt werden:

<script language="javascript">
func­tion showMyHelpPage() {
window.open('/HelpWiki/Wiki%20Pages/AppHelp.aspx','MyApplicationHelp');
return false;
}
WPSC.RegisterForEvent("urn:schemas-microsoft-com:dhtml","onhelp",showMyHelpPage);
</script>

WPSC1

Der Inhalt ist schnell erklärt: Im obe­ren Teil die Funktion "showMyHelpPage" öff­net die Hilfeseite in einem neuen Fenster und im unte­ren Teil wird mit­tels WPSC.RegisterForEvent die obige Funktion für das Ereignis regis­triert. "return false;" am Ende der JavaScript-Funktion unter­bin­det, dass sich die brow­s­er­ei­gene Hilfe auch noch öff­net und der Anwender von Hilfeseiten erschla­gen wird.

Nun wird wird das WebPart noch aus­ge­blen­det mit­tels Chrome-Eigenschaft "None". Die Dialoge und der Bearbeitungsmodus kön­nen nun wie­der ver­las­sen werden.

Drückt der Anwender nun auf der Webseite F1, so öff­net sich ein neues Browserfenster, in dem die Hilfetexte stehen.

Natürlich kön­nen diese Funktionen nicht nur in die Webpartseiten, son­dern auch direkt in die Masterpage ein­ge­bet­tet wer­den – dann muss die JavaScript-Funktion zum Aufruf der Hilfeseite mit ent­spre­chen­den Parametern ver­se­hen und etwas mehr einer Logik gefüllt werden.

Ich denke  es wird deut­lich, das man hier ein paar nette Funktionen an die Hand bekommt, mit denen man die User Experience ver­bes­sern kann.

Weitere Informationen zu WPSC fin­den sich im SharePoint-SDK oder in der MSDN.

Related Posts

Pin It on Pinterest