HtmlDesignerAttribute class

定義的網頁組件的自訂屬性用於HtmlDesigner屬性。它會指定如果的自訂屬性會使用自訂產生器和產生器] 中的 URL，或自訂屬性不會使用任何產生器，包括任何預設產生器。

Inheritance hierarchy

System.Object
  System.Attribute
    Microsoft.SharePoint.WebPartPages.HtmlDesignerAttribute

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'宣告
<AttributeUsageAttribute(AttributeTargets.Property)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class HtmlDesignerAttribute _
    Inherits Attribute
'用途
Dim instance As HtmlDesignerAttribute

[AttributeUsageAttribute(AttributeTargets.Property)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class HtmlDesignerAttribute : Attribute

備註

在 Microsoft Visual Studio 2005 中開啟網頁組件，則會忽略HtmlDesignerAttribute類別。僅預設 Visual Studio 2005 建置者將會使用。

Examples

下列程式碼範例會顯示使用HtmlDesignerAttribute ，以定義靜態自訂產生器的自訂屬性對網頁組件。

using System;
using System.ComponentModel;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Xml.Serialization;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Utilities;
using Microsoft.SharePoint.WebPartPages;
using System.Xml;

namespace WebPartLibrary2
{
    
    [XmlRootAttribute(Namespace="WebPartLibrary2")]

    
    public class HtmlDesignerAttributeTestPart: WebPart
    {
        ///    Member variable for a property with 
        ///    HtmlDesignerAttribute defined for a custom builder
        private string customPropertyValue = "This Web Part has a custom property";
        
        /// <summary>
        ///        Use HtmlDesignerAttribute to define a static custom 
        ///        builder builder.aspx for the custom property.
        /// </summary>
        [WebPartStorage(Storage = Storage.Personal), 
        DefaultValue(""), 
        HtmlDesignerAttribute("http://myserver/builder.aspx")]
        public string CustomProperty
        {
            get
            {
                return customPropertyValue;
            }
            set
            {    
                customPropertyValue = value;
            }
        }
        
        /// <summary>
        ///        Renders the content of the HtmlDesignerAttributeTestPart.
        /// </summary>
        protected override void RenderWebPart (HtmlTextWriter output)
        {
            output.Write(SPEncode.HtmlEncode(CustomProperty));
        }
    }

}

Imports System
Imports System.ComponentModel
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Xml.Serialization
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Utilities
Imports Microsoft.SharePoint.WebPartPages
Imports System.Xml

Namespace WebPartLibrary2

    <XmlRootAttribute(Namespace:="WebPartLibrary2")> _
    Public Class HtmlDesignerAttributeTestPart
        Inherits WebPart
        '''    Member variable for a property with 
        '''    HtmlDesignerAttribute defined for a custom builder
        Private customPropertyValue As String = "This Web Part has a custom property"

        ''' <summary>
        '''        Use HtmlDesignerAttribute to define a static custom 
        '''        builder builder.aspx for the custom property.
        ''' </summary>
        <WebPartStorage(Storage := Storage.Personal), DefaultValue(""), HtmlDesignerAttribute("http://myserver/builder.aspx")> _
        Public Property CustomProperty() As String
            Get
                Return customPropertyValue
            End Get
            Set(ByVal value As String)
                customPropertyValue = value
            End Set
        End Property

        ''' <summary>
        '''        Renders the content of the HtmlDesignerAttributeTestPart.
        ''' </summary>
        Protected Overrides Sub RenderWebPart(ByVal output As HtmlTextWriter)
            output.Write(SPEncode.HtmlEncode(CustomProperty))
        End Sub
    End Class

End Namespace

Thread safety

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

請參閱

參照

HtmlDesignerAttribute members

Microsoft.SharePoint.WebPartPages namespace