{"id":1163,"date":"2011-06-11T17:59:50","date_gmt":"2011-06-11T15:59:50","guid":{"rendered":"http:\/\/www.itidea.nl\/?p=1163"},"modified":"2011-06-11T17:59:50","modified_gmt":"2011-06-11T15:59:50","slug":"simple-provider-consumer-visual-webparts","status":"publish","type":"post","link":"https:\/\/www.itidea.nl\/index.php\/simple-provider-consumer-visual-webparts\/","title":{"rendered":"Simple Provider Consumer Visual Webparts"},"content":{"rendered":"

Because of a question on http:\/\/sharepoint.stackexchange.com\/questions\/14325\/created-connectable-webparts-but-the-connections-menu-item-is-not-showing<\/a>\u00a0I decided to create a provider consumer webpart in\u00a0his most simple form.\u00a0\u00a0\u00a0<\/p>\n

Create an empty SharePoint project in Visual studio.
\nAdd two Visual WebParts:\u00a0\u00a0\u00a0<\/p>\n

    \n
  1. ProviderVisualWebpart<\/li>\n
  2. ConsumerVisualWebpart<\/li>\n<\/ol>\n

    \u00a0\u00a0\u00a0<\/p>\n

    In this most simple form of a provider consumer webpart only one string is passed from the provider to the consumer and it displayed in a Label control on the consumer webpart.\u00a0\u00a0\u00a0<\/p>\n

    Code in ProviderVisualWebpart.cs:\u00a0\u00a0\u00a0<\/p>\n

    \r\n\r\npublic class ProviderVisualWebPart : System.Web.UI.WebControls.WebParts.WebPart, ITransformableFilterValues\r\n{\r\n\u00a0\u00a0\u00a0 private const string _ascxPath = @"~\/_CONTROLTEMPLATES\/ConsumerProviderVWP\/ProviderVisualWebPart\/ProviderVisualWebPartUserControl.ascx";\r\n\u00a0\r\n\r\n\u00a0\u00a0\u00a0 protected override void CreateChildControls()\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Control control = Page.LoadControl(_ascxPath);\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Controls.Add(control);\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 public string ParameterName\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 get\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return "Letter";\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 public ReadOnlyCollection<string> ParameterValues\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 get\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 List<string> values = this.GetValues();\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return new ReadOnlyCollection<string>(values);\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 private List<string> GetValues()\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 List<string> valueList = new List<string>();\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 valueList.Add("A");\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return valueList;\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 [ConnectionProvider("Letter Filter", "ITransformableFilterValues")]\r\n\u00a0\u00a0\u00a0 public ITransformableFilterValues SetConnectionInterface()\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return this;\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 public bool AllowEmptyValue\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 get { return true; }\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 public bool AllowMultipleValues\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 get { return false; }\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 public bool AllowAllValue\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 get { return true; }\r\n\u00a0\u00a0\u00a0 }\r\n}\r\n\r\n\r\n<\/pre>\n
    \u00a0\u00a0\u00a0\u00a0<\/p>\n
    Code in ConsumerVisualWebpart.cs:\u00a0\u00a0\u00a0<\/p>\n
    \r\n\r\npublic class ConsumerVisualWebPart : System.Web.UI.WebControls.WebParts.WebPart\r\n{\r\n\u00a0\u00a0\u00a0 private const string _ascxPath = @"~\/_CONTROLTEMPLATES\/ConsumerProviderVWP\/ConsumerVisualWebPart\/ConsumerVisualWebPartUserControl.ascx";\r\n\r\n\r\n\u00a0\u00a0\u00a0 public ConsumerVisualWebPart()\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 _filterProviders = new List<IFilterValues>();\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 protected override void CreateChildControls()\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ConsumerVisualWebPartUserControl control = (ConsumerVisualWebPartUserControl)Page.LoadControl(_ascxPath);\r\n\u00a0\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 control.ValueSendByProviderProperty = "From provider: ";\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 foreach (IFilterValues filter in FilterProviders)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 if (filter.ParameterValues != null)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 foreach (string item in filter.ParameterValues)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 control.ValueSendByProviderProperty += item;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Controls.Add(control);\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 protected override void Render(HtmlTextWriter writer)\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 base.Render(writer);\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 foreach (IFilterValues filter in FilterProviders)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 writer.WriteLine(string.Format("Parameter: {0} <br>", filter.ParameterName));\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 \/\/\/ <summary>\r\n\u00a0\u00a0\u00a0 \/\/\/ Hold incoming filtervalues\r\n\u00a0\u00a0\u00a0 \/\/\/ <\/summary>\r\n\u00a0\u00a0\u00a0 private List<IFilterValues> _filterProviders;\r\n\u00a0\u00a0\u00a0 private List<IFilterValues> FilterProviders\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 get { return _filterProviders; }\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\r\n\u00a0\u00a0\u00a0 [ConnectionConsumer("filter", "UniqueIDForConsumer", AllowsMultipleConnections = true)]\r\n\u00a0\u00a0\u00a0 public void SetFilter(IFilterValues filterValues)\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 if (filterValues != null)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 List<ConsumerParameter> parameters = new List<ConsumerParameter>();\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 parameters.Add(new ConsumerParameter("Letter", ConsumerParameterCapabilities.SupportsSingleValue | ConsumerParameterCapabilities.SupportsAllValue | ConsumerParameterCapabilities.SupportsEmptyValue));\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 filterValues.SetConsumerParameters(new System.Collections.ObjectModel.ReadOnlyCollection<ConsumerParameter>(parameters));\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 this.FilterProviders.Add(filterValues);\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0 }\r\n}\r\n\r\n\r\n<\/pre>\n
    Code in ConsumerVisualWebpartUserControl.ascx.cs:\u00a0\u00a0\u00a0<\/p>\n
    \r\n\r\npublic partial class ConsumerVisualWebPartUserControl : UserControl\r\n{\r\n\u00a0\u00a0\u00a0 public string ValueSendByProviderProperty { get; set; }\r\n\u00a0\r\n\r\n\u00a0\u00a0\u00a0 protected void Page_Load(object sender, EventArgs e)\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ValueSendByProvider.Text = ValueSendByProviderProperty;\r\n\u00a0\u00a0\u00a0 }\r\n}\r\n\r\n\r\n<\/pre>\n
    Control added to VisualWebpart.ascx:\u00a0\u00a0\u00a0<\/p>\n
    \r\n\r\n<asp:Label ID="ValueSendByProvider" runat="server" Text="Label"><\/asp:Label>\r\n\r\n\r\n<\/pre>\n
    That’s it!\u00a0\u00a0\u00a0<\/p>\n
    Put both controls on a page and connect them to each other.\u00a0\u00a0\u00a0<\/p>\n
    No connection set:\u00a0\u00a0\u00a0<\/p>\n
    \"\"<\/a>\u00a0Connect:\u00a0\u00a0\u00a0<\/p>\n
    \"\"<\/a>Configure:\u00a0\u00a0\u00a0<\/p>\n
    \"\"<\/a>Connection established:\u00a0\u00a0\u00a0<\/p>\n
    \"\"<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
    Because of a question on http:\/\/sharepoint.stackexchange.com\/questions\/14325\/created-connectable-webparts-but-the-connections-menu-item-is-not-showing\u00a0I decided to create a provider consumer webpart in\u00a0his most simple form.\u00a0\u00a0\u00a0 Create an empty SharePoint project in Visual studio. Add two Visual WebParts:\u00a0\u00a0\u00a0 ProviderVisualWebpart ConsumerVisualWebpart \u00a0\u00a0\u00a0 In this most simple form of a provider … Read More »<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8],"tags":[20,42,6],"class_list":["post-1163","post","type-post","status-publish","format-standard","hentry","category-sharepoint-2010","tag-c","tag-sharepoint-2010","tag-visual-studio"],"_links":{"self":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts\/1163","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/comments?post=1163"}],"version-history":[{"count":7,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts\/1163\/revisions"}],"predecessor-version":[{"id":1174,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts\/1163\/revisions\/1174"}],"wp:attachment":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/media?parent=1163"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/categories?post=1163"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/tags?post=1163"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}