NotifyParentPropertyAttribute Třída

Definice

Obor názvů:

System.ComponentModel

Sestavení:

netstandard.dll, System.ComponentModel.Primitives.dll

Zdroj:

NotifyParentPropertyAttribute.cs

Označuje, že nadřazená vlastnost je upozorněna, když hodnota vlastnosti, na kterou se tento atribut použije, je změněn. Tuto třídu nelze zdědit.

public ref class NotifyParentPropertyAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class NotifyParentPropertyAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type NotifyParentPropertyAttribute = class
    inherit Attribute

Public NotInheritable Class NotifyParentPropertyAttribute
Inherits Attribute

Dědičnost

Object

Attribute

NotifyParentPropertyAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad kódu ukazuje, jak použít NotifyParentPropertyAttribute a ExpandableObjectConverter třída k vytvoření rozbalitelné vlastnosti vlastního ovládacího prvku.

using System;
using System.ComponentModel;
using System.Drawing;
using System.Globalization;
using System.Windows.Forms;

namespace ExpandableObjectDemo;

public partial class DemoControl : UserControl
{
    Container components;

    public DemoControl() => InitializeComponent();

    protected override void Dispose(bool disposing)
    {
        if (disposing && (components != null))
        {
            components.Dispose();
        }
        base.Dispose(disposing);
    }

    [Browsable(true)]
    [EditorBrowsable(EditorBrowsableState.Always)]
    [Category("Demo")]
    [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
    public BorderAppearance Border { get; set; } = new();

    void InitializeComponent()
    {
        components = new Container();
        AutoScaleMode = AutoScaleMode.Font;
    }
}

[TypeConverter(typeof(BorderAppearanceConverter))]
public class BorderAppearance
{
    int borderSizeValue = 1;
    Color borderColorValue = Color.Empty;

    [Browsable(true),
    NotifyParentProperty(true),
    EditorBrowsable(EditorBrowsableState.Always),
    DefaultValue(1)]
    public int BorderSize
    {
        get => borderSizeValue;
        set
        {
            if (value < 0)
            {
                throw new ArgumentOutOfRangeException(
                    "BorderSize",
                    value,
                    "must be >= 0");
            }

            if (borderSizeValue != value)
            {
                borderSizeValue = value;
            }
        }
    }

    [Browsable(true)]
    [NotifyParentProperty(true)]
    [EditorBrowsable(EditorBrowsableState.Always)]
    [DefaultValue(typeof(Color), "")]
    public Color BorderColor
    {
        get => borderColorValue;
        set
        {
            if (value.Equals(Color.Transparent))
            {
                throw new NotSupportedException("Transparent colors are not supported.");
            }

            if (borderColorValue != value)
            {
                borderColorValue = value;
            }
        }
    }
}

public class BorderAppearanceConverter : ExpandableObjectConverter
{
    // This override prevents the PropertyGrid from 
    // displaying the full type name in the value cell.
    public override object ConvertTo(
        ITypeDescriptorContext context,
        CultureInfo culture,
        object value,
        Type destinationType) => destinationType == typeof(string)
            ? ""
            : base.ConvertTo(
            context,
            culture,
            value,
            destinationType);
}

Imports System.ComponentModel
Imports System.Drawing
Imports System.Globalization
Imports System.Windows.Forms

Public Class DemoControl
    Inherits UserControl

    Private borderAppearanceValue As New BorderAppearance()
    Private components As System.ComponentModel.IContainer = Nothing


    Public Sub New()
        InitializeComponent()

    End Sub

    Protected Overrides Sub Dispose(ByVal disposing As Boolean)

        If disposing AndAlso (components IsNot Nothing) Then
            components.Dispose()
        End If

        MyBase.Dispose(disposing)

    End Sub

    <Browsable(True), _
    EditorBrowsable(EditorBrowsableState.Always), _
    Category("Demo"), _
    DesignerSerializationVisibility(DesignerSerializationVisibility.Content)> _
    Public Property Border() As BorderAppearance

        Get
            Return Me.borderAppearanceValue
        End Get

        Set(ByVal value As BorderAppearance)
            Me.borderAppearanceValue = value
        End Set

    End Property

    Private Sub InitializeComponent()
        components = New System.ComponentModel.Container()
        Me.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font

    End Sub
End Class

<TypeConverter(GetType(BorderAppearanceConverter))>  _
Public Class BorderAppearance
    Private borderSizeValue As Integer = 1
    Private borderColorValue As Color = Color.Empty
    
    
    <Browsable(True), NotifyParentProperty(True), EditorBrowsable(EditorBrowsableState.Always), DefaultValue(1)>  _
    Public Property BorderSize() As Integer 
        Get
            Return borderSizeValue
        End Get
        Set
            If value < 0 Then
                Throw New ArgumentOutOfRangeException("BorderSize", value, "must be >= 0")
            End If
            
            If borderSizeValue <> value Then
                borderSizeValue = value
            End If
        End Set
    End Property
    
    
    <Browsable(True), NotifyParentProperty(True), EditorBrowsable(EditorBrowsableState.Always), DefaultValue(GetType(Color), "")>  _
    Public Property BorderColor() As Color 
        Get
            Return borderColorValue
        End Get
        Set
            If value.Equals(Color.Transparent) Then
                Throw New NotSupportedException("Transparent colors are not supported.")
            End If
            
            If borderColorValue <> value Then
                borderColorValue = value
            End If
        End Set
    End Property
End Class

Public Class BorderAppearanceConverter
    Inherits ExpandableObjectConverter
    
    ' This override prevents the PropertyGrid from 
    ' displaying the full type name in the value cell.
    Public Overrides Function ConvertTo(ByVal context As ITypeDescriptorContext, ByVal culture As CultureInfo, ByVal value As Object, ByVal destinationType As Type) As Object

        If destinationType Is GetType(String) Then
            Return ""
        End If

        Return MyBase.ConvertTo(context, culture, value, destinationType)

    End Function
End Class

Poznámky

Platí NotifyParentPropertyAttribute pro vlastnost, pokud má nadřazená vlastnost obdržet oznámení o změnách hodnot vlastnosti. Například v okně Vlastnosti má DataGridView.RowTemplate vlastnost vnořené vlastnosti, například Height a DefaultCellStyle. Tyto vnořené vlastnosti jsou označené NotifyParentPropertyAttribute(true) tak, aby upozorňují nadřazenou vlastnost, aby aktualizovala její hodnotu a zobrazila se při změně hodnot vlastností.

Další informace o používání atributů naleznete v tématu Atributy.

Konstruktory

Name	Description
NotifyParentPropertyAttribute(Boolean)	Inicializuje novou instanci NotifyParentPropertyAttribute třídy pomocí zadané hodnoty určit, zda nadřazená vlastnost je upozorněna na změny hodnoty vlastnosti.

Pole

Name	Description
Default	Označuje výchozí stav atributu, že vlastnost by neměla informovat nadřazenou vlastnost o změnách jeho hodnoty. Toto pole je jen pro čtení.
No	Označuje, že nadřazená vlastnost není upozorněna na změny hodnoty vlastnosti. Toto pole je jen pro čtení.
Yes	Označuje, že nadřazená vlastnost je upozorněna na změny hodnoty vlastnosti. Toto pole je jen pro čtení.

Vlastnosti

Name	Description
NotifyParent	Získá nebo nastaví hodnotu určující, zda nadřazená vlastnost by měla být upozorněna na změny hodnoty vlastnosti.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Name	Description
Equals(Object)	Získá hodnotu určující, zda zadaný objekt je stejný jako aktuální objekt.
GetHashCode()	Získá hash kód pro tento objekt.
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Získá hodnotu určující, zda aktuální hodnota atributu je výchozí hodnota atributu.
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• ExpandableObjectConverter
• Attribute