Compartilhar via


WebPart.GetCustomBuilder Method

Provides the ability to associate a dynamic builder with a custom property of a Web Part.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
Protected Overridable Function GetCustomBuilder ( _
    propertyName As String _
) As String
'Usage
Dim propertyName As String
Dim returnValue As String

returnValue = Me.GetCustomBuilder(propertyName)
protected virtual string GetCustomBuilder(
    string propertyName
)

Parameters

  • propertyName
    Type: System.String

    The name of the property to associate with a dynamic builder.

Return Value

Type: System.String
A string that contains the URL for launching your custom builder.

Remarks

Implement the GetCustomBuilder method in your WebPart when you want to associate a dynamic builder with a custom property. The GetCustomBuilder method is called only when a property has its HtmlDesignerAttribute set to a BrowserBuilderType value of Dynamic. The GetCustomBuilder method you implement in your WebPart should accept the property name as a string and generate a URL that will launch the dynamic builder for that property. The URL itself should point to an ASPX or HTML file that can be launched inside a ShowModalDialog method to complete the builder functionality.

If the assembly for your builder is deployed as a class resource, you must deploy the assembly in the global assembly cache. Assemblies deployed in the \inetpub\wwwroot\bin folder will not be allowed to use ASPX or ASMX files as class resources.

See Also

Reference

WebPart Class

WebPart Members

Microsoft.SharePoint.WebPartPages Namespace