SharePoint 2013 - Read web part properties with client side JavaScript.

Hello,

Sometimes we want to be able to read web part properties on our client side code, e.g. when we want to use jQuery functionality to implement certain requirements.

Easiest way to achieve this is just use the asp:HiddenField control to store the value of the property, then get the value using jQuery.

So on your html:

?
1
<asp:HiddenField ID="hidMyProp" runat="server" />
Then on the JavaScript section:
?
1
2
3
$(function () {
    var myProp = $('#' + '<%=hidMyProp.ClientID%>').val() != '' ? $('#' + '<%=hidMyProp.ClientID%>').val() : 'default';
});


On your ascx code behind file, just store the value during page load:
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
[ToolboxItemAttribute(false)]
public partial class MyWebPart: WebPart
{
    [WebBrowsable(true),
     WebDisplayName("My Property"),
     WebDescription("My Web Part Custom Property"),
     Personalizable(PersonalizationScope.Shared),
     Category("My Custom Web Parts")]
    public string MyProp { get; set; }
 
    public MyWebPart()
    {
    }
 
    protected override void OnInit(EventArgs e)
    {
        base.OnInit(e);
        InitializeControl();
    }
 
    protected void Page_Load(object sender, EventArgs e)
    {
        string myProp = this.MyProp;
        hidMyProp.Value = myProp;
    }
}


Hope this helps,
Andreas

Comments

Post a Comment

Popular posts from this blog

SharePoint 2013 anonymous access add attachments to list item

Image
Hi, Sometimes you want to enable anonymous access to be able to add a list item but at the same time attaching some documents. After good few hours playing around trying to make this work, turns out that we can achieve this functionality. The trick is to use RunWithElevatedPrivileges method for the file upload. We also want the file upload functionality to be available on the NewForm.aspx as it wouldn't make sense to put it in other forms as any user would be able to upload files to other records. The result will be something like this: When it is saved, the user is redirected to the display form: The close button then will take the user back to the homepage (or any page you desire) The steps: 1. Create an ascx control to host your file upload control in your project.  Put the below script in the ascx as well (credit to this post ): The code behind: 2. Create custom form template. You have to put the ascx in the CONTROLTEMPLATES folder of the ...
Read more

CRM Plugin - Parent and Child Pipeline

This concept tends to confuse people often - and I was no exception. I came across this problem when trying to create custom auto-numbering for one of my projects. Creating auto-number for Opportunity is easy. This is because the user creates opportunity straight from the home screen - thus the plugin runs on parent pipeline. However, it's a different story if you are dealing with Quote entity. Quote can be created in 2 ways, through the home screen OR the opportunity screen. If you create it from the latter, it will run on the child pipeline and you will find that your plugin will not work. Registering it as a child pipeline is easy, but CRM makes it harder since you can't use ICRMService. Instead, you have to create CRMService manually by using this piece of code: Not only that, with the child plugin you can't use Query expression to fetch other entities in your code unless you register it as ASYNCHRONOUS plugin. Mark Kovalcson in his blog found out that: A C...
Read more