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önnen recht einfach zusätzliche Funktionalitäten eingebunden werden. WPSC ist ein Satz von JavaScript-Funktionen erlaubt, dass z.B. Webparts untereinander, mit SharePoint und mit dem Benutzer interagieren.

Im Folgenden möchte ich anhand des Beispiels von Woody Windishman kurz im Ansatz zeigen, welche Möglichkeiten sich bieten.

Oft erwarten Benutzer von Webanwendungen die gleichen Features, die sie auch von Desktop-Anwendungen schon kennen. Ein in Desktopanwendungen sehr triviales und leicht zu implementierendes Beispiel – wie Aufruf einer kontextsensitiven Hilfe bie Druck auf F1 – gestaltet sich im Web schon schwieriger. Hier können WPSC eine Brücke schlagen.

Wie realisiert man das Ganze nun? Das Prinzip ist recht einfach und in zwei simplen Schritten erklärt:

  1. Man erzeugt eine JavaScript-Funktion, die in einem neuen Fenster die Hilfe-HTML-Seite öffnet.
  2. Man registriert diese Funktion für den gewünschten Event.

Soweit die Theorie – nun zur Praxis:

Gehen wir davon aus, dass bereits eine Hilfeseite existiert – im Beispiel die Seite AppHelp.aspx in der Wiki-Bibliothek HelpWiki. Weiterhin gehen wir davon aus, dass eine WebPart-Page existiert, für die Kontexthilfe angeboten werden soll.

Nun soll das JavaScript zum Aufruf der Hilfeseite integriert werden. Das geht recht einfach mit einem Content-Editor-Webpart durchgeführt werden. Aus diesem Grund öffnen 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öffnet und folgendes JavaSript hinzugefügt werden:

<script language=“javascript“>
function 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 oberen Teil die Funktion „showMyHelpPage“ öffnet die Hilfeseite in einem neuen Fenster und im unteren Teil wird mittels WPSC.RegisterForEvent die obige Funktion für das Ereignis registriert. „return false;“ am Ende der JavaScript-Funktion unterbindet, dass sich die browsereigene Hilfe auch noch öffnet und der Anwender von Hilfeseiten erschlagen wird.

Nun wird wird das WebPart noch ausgeblendet mittels Chrome-Eigenschaft „None“. Die Dialoge und der Bearbeitungsmodus können nun wieder verlassen werden.

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

Natürlich können diese Funktionen nicht nur in die Webpartseiten, sondern auch direkt in die Masterpage eingebettet werden – dann muss die JavaScript-Funktion zum Aufruf der Hilfeseite mit entsprechenden Parametern versehen und etwas mehr einer Logik gefüllt werden.

Ich denke  es wird deutlich, das man hier ein paar nette Funktionen an die Hand bekommt, mit denen man die User Experience verbessern kann.

Weitere Informationen zu WPSC finden sich im SharePoint-SDK oder in der MSDN.

Kommentar hinterlassen


Pin It on Pinterest