Missing Custom Property in Visual WebPart

Question

I have created a new Visual WebPart with custom webpart property that deployed successfully, but when adding the Visual WebPart to my Page and editing its properties, I noted that the custom webpart property is not shown

It's my code to add a custom property in Visual WebPart

using System;
using System.ComponentModel;
using System.Diagnostics;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace WPs.ContactForm {

  public partial class ContactFormUserControl: UserControl {

    [WebBrowsable(true),
      WebDisplayName("UserName"),
      WebDescription("Enter User Name"),
      Personalizable(PersonalizationScope.Shared),
      Category("Mail Settings")

    ]
    public string username {
      get;
      set;
    }

  }
}

How I can show a custom property in Visual WebPart?

Answer 1

Why Custom Property is not shown in Visual WebPart?

This behavior occurs in case you are using Visual WebPart (Farm Solution Only) that inherits from UserControl, not from System.Web.UI.WebControls.WebParts.WebPart.

So, in your case, to get your custom property shown and working as expected, you have to add your custom property in the webpart.cs file that contains a partial class that inherits from System.Web.UI.WebControls.WebParts.WebPart, NOT in the UserControl.ascx.cs file.

Otherwise, you have to use Visual WebPart (Sandbox). but it may not satisfy your requirements and has many limitations.

For more details about how you can use Custom Property in Visual WebPart (Farm Solution Only), Please check How to Create Custom Web Part Property in SharePoint Visual WebPart