{"id":4249,"date":"2017-07-20T10:10:53","date_gmt":"2017-07-20T08:10:53","guid":{"rendered":"https:\/\/sii.pl\/blog\/?p=4249"},"modified":"2023-08-29T11:30:08","modified_gmt":"2023-08-29T09:30:08","slug":"kontrolka-delegatecontrol","status":"publish","type":"post","link":"https:\/\/sii.pl\/blog\/kontrolka-delegatecontrol\/","title":{"rendered":"Kontrolka DelegateControl"},"content":{"rendered":"\n

Zdarzaj\u0105 si\u0119 momenty, w kt\u00f3rych chcieliby\u015bmy doda\u0107 do strony dodatkow\u0105 funkcjonalno\u015b\u0107, czy zmieni\u0107 wygl\u0105d strony. Nie mo\u017cemy jednak utworzy\u0107 nowej lub zmodyfikowa\u0107 ju\u017c istniej\u0105cej strony wzorcowej (master page), bo np. klient sobie tego nie \u017cyczy albo wi\u0105za\u0142oby si\u0119 to z du\u017cym nak\u0142adem pracy. W\u0142a\u015bnie w takim celu powsta\u0142a kontrolka DelegateControl.<\/p>\n\n\n\n

Jest to mechanizm dzia\u0142aj\u0105cy jako kontener. Umo\u017cliwia on wstrzykni\u0119cie kontrolki\/kontrolek w miejscu, gdzie kontrolka DelegateControl  wyst\u0119puje. Podczas otwierania strony kontrolka DelegateControl szuka zarejestrowanych kontrolek. W przypadku znalezienia kontrolek, w zale\u017cno\u015bci od ustawie\u0144 kontrolki DelegateControl, w ich miejsce renderowana jest albo jedna, albo wszystkie.<\/p>\n\n\n\n

W ten spos\u00f3b, poprzez dodanie w\u0142asnych wpis\u00f3w lub wykorzystaniu ju\u017c istniej\u0105cych, na stronie wzorcowej mo\u017cna doda\u0107 nowe funkcjonalno\u015bci do wszystkich stron korzystaj\u0105cych z danej strony wzorcowej.<\/p>\n\n\n\n

Zatem zaczynajmy.<\/p>\n\n\n\n

Ka\u017cda \u201cpude\u0142kowa\u201d strona wzorcowa w bloku HEAD zawiera wpis:<\/p>\n\n\n

\n<SharePoint:DelegateControl runat="server"\n \nControlId="AdditionalPageHead"\n \nAllowMultipleControls="true"\/>\n<\/pre><\/div>\n\n\n
gdzie:<\/p>\n\n\n\n
ControlId<\/strong> \u2013 id identyfikuj\u0105ce kontrolk\u0119 DelegateControl,<\/p>\n\n\n\n
AllowMultipleControls<\/strong> \u2013 okre\u015bla, czy kontrolka DelegateControl mo\u017ce wyrenderowa\u0107 kilka kontrolek czy tylko jedn\u0105.<\/p>\n\n\n\n
Jako przyk\u0142ad przygotujemy kontrolk\u0119 dodaj\u0105c\u0105 arkusz stylu CSS ukrywaj\u0105cego lewe menu boczne.<\/p>\n\n\n\n
Pozwoli to sprawdzi\u0107 w prosty spos\u00f3b, czy kod dzia\u0142a. Poza tym, bazuj\u0105c na moim do\u015bwiadczeniu, klienci nad wyraz cz\u0119sto chc\u0105 by to menu by\u0142o ukryte.<\/p>\n\n\n\n
Na pocz\u0105tek utworzymy now\u0105, farmow\u0105 solucj\u0119 SharePoint\u2019ow\u0105 BlogerSii.Examples.DelegateControl.<\/p>\n\n\n\n
W Visual Studio dodaj SharePoint\u2019owy folder \u201eLayouts\u201d<\/p>\n\n\n\n
\"SharePoint<\/a><\/figure>\n\n\n\n
Nast\u0119pnie dodaj do niego plik arkuszu styl\u00f3w CSS \u201eHideMenu.css\u201d.<\/p>\n\n\n\n
\"Layout<\/a><\/figure>\n\n\n\n
Wklej do nowo utworzonego pliku definicji stylu:<\/p>\n\n\n
\n#sideNavBox { \ndisplay:none; \n}\n<\/pre><\/div>\n\n\n
W Visual Studio dodaj nowy User Control HideSideMenuControl.ascx<\/p>\n\n\n\n
\"Add<\/a><\/figure>\n\n\n\n
Do pliku HideSideMenuControl.ascx dodaj wpis:<\/p>\n\n\n
\n<link rel="stylesheet" href="\/_layouts\/15\/DelegateControl\/HideMenu.css" \/>\n<\/pre><\/div>\n\n\n
\"\"<\/a><\/figure>\n\n\n\n
Mamy ju\u017c kontrolk\u0119 – teraz trzeba j\u0105 wykorzysta\u0107.<\/p>\n\n\n\n
S\u0142u\u017cy do tego odpowiednio przygotowany dokument XML.<\/p>\n\n\n\n
W Visual Studio dodaj \u201eEmpty Element\u201d. W Elements.xml dodaj wpis:<\/p>\n\n\n
\n\t<Control Id="AdditionalPageHead" Sequence="90" ControlSrc="~\/_CONTROLTEMPLATES\/15\/DelegateControl\/HideSideMenuControl.ascx " \/>\n<\/pre><\/div>\n\n\n
\"Elements.xml\"<\/a><\/figure>\n\n\n\n
Tak przygotowany dokument XML pozwala na powi\u0105zanie kontrolki ASP.NET z kontrolk\u0105 DelegateControl, gdzie:<\/p>\n\n\n\n
ID<\/strong> – definiuje, kt\u00f3ra kontrolka DelegateControl ma wyrenderowa\u0107 nasz\u0105 kontrolk\u0119,<\/p>\n\n\n\n
Sequence<\/strong> \u2013 w przypadku, gdy kontrolka DelegateControl nie ma flagi AllowMultipleControls ustawionej na \u201etrue\u201d lub w og\u00f3le jej nie ma, o tym, kt\u00f3ra kontrolka zostanie wstrzykni\u0119ta, decyduje sequence – wygrywa ta, kt\u00f3ra ma najni\u017csz\u0105 warto\u015b\u0107,<\/p>\n\n\n\n
ControlSrc<\/strong> \u2013 lokalizacja wstrzykiwanego elementu.<\/p>\n\n\n\n
Utworzony element nale\u017cy doda\u0107 do funkcji (feature) o zakresie (scope) \u201eWeb\u201d.<\/p>\n\n\n\n
\"Scope<\/a><\/figure>\n\n\n\n
Zasi\u0119g elementu jest zale\u017cny od zakresu (scope) funkcji (feature), do kt\u00f3rej dodajemy element z naszym plikiem XML:<\/p>\n\n\n\n