Share via


HtmlDesignerAttribute Class

The HtmlDesignerAttribute class defines the HtmlDesigner attribute that is used on a Web Part custom property. It specifies if a custom property uses a custom builder and the URL of the builder, or if the custom property does not use any builder, including any default builder.

System.Object

   System.Attribute

      Microsoft.SharePoint.WebPartPages.HtmlDesignerAttribute

Public Constructors

The following table shows the constructors of the HtmlDesignerAttribute class with a brief description.

Name Description
HtmlDesignerAttribute Initializes a new instance of the HtmlDesignerAttribute class.

Public Properties

The following table shows the properties of the HtmlDesignerAttribute class, the data type of each property, and a brief description of each.

Name Data Type Description
BuilderArguments String Holds any arguments used by the builder.
BuilderType String Holds an enumeration for the builder
BuilderUrl String Specifies the URL of the .aspx page of the builder.
DialogFeatures String Used to specify the shape, size or other features of the dialog.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Remarks

When a Web Part is opened in Microsoft® Visual Studio® .NET, the HtmlDesignerAttribute class is ignored. Only the default Visual Studio .NET builders will be used.

Example

The following code example shows a Web Part with a custom property that uses HtmlDesignerAttribute to define a static custom builder.

Requirements

Namespace: Microsoft.SharePoint.WebPartPages

Platforms: Windows Server 2003

Assembly: Windows SharePoint Services (in Microsoft.SharePoint.dll)

Security: Code Access Security