Share via


HtmlDesignerAttribute-Klasse

Definiert das HtmlDesigner -Attribut, das auf einer benutzerdefinierten Webpart-Eigenschaft verwendet wird. Es gibt an, wenn eine benutzerdefinierte Eigenschaft eines benutzerdefinierten-Generators und die URL des-Generators verwendet wird, oder wenn die benutzerdefinierte Eigenschaft keine Builder, sowie alle Standard-Generator verwendet wird.

Vererbungshierarchie

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

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Property)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class HtmlDesignerAttribute _
    Inherits Attribute
'Usage
Dim instance As HtmlDesignerAttribute
[AttributeUsageAttribute(AttributeTargets.Property)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class HtmlDesignerAttribute : Attribute

Hinweise

Wenn ein Webpart in Microsoft Visual Studio 2005 geöffnet wird, wird die Klasse HtmlDesignerAttribute ignoriert. Nur die standardmäßige Visual Studio 2005-Generatoren werden verwendet werden.

Beispiele

Das folgende Codebeispiel zeigt ein Webpart mit einer benutzerdefinierten Eigenschaft, die HtmlDesignerAttribute verwendet, um eine statische benutzerdefinierte Generator zu definieren.

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

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic) Member dieses Typs sind threadsicher. Die Threadsicherheit von Instanzmembern ist nicht gewährleistet.

Siehe auch

Referenz

HtmlDesignerAttribute-Member

Microsoft.SharePoint.WebPartPages-Namespace