DependencyObject.ClearValue 方法

定义

命名空间:

System.Windows

程序集:

WindowsBase.dll

清除属性的本地值。

重载

ClearValue(DependencyProperty)	清除属性的本地值。 要清除的属性由 DependencyProperty 标识符指定。
ClearValue(DependencyPropertyKey)	清除只读属性的本地值。 要清除的属性由 DependencyPropertyKey 指定。

ClearValue(DependencyProperty)

清除属性的本地值。 要清除的属性由 DependencyProperty 标识符指定。

public:
 void ClearValue(System::Windows::DependencyProperty ^ dp);

public void ClearValue (System.Windows.DependencyProperty dp);

member this.ClearValue : System.Windows.DependencyProperty -> unit

Public Sub ClearValue (dp As DependencyProperty)

参数

dp

DependencyProperty

要清除的由 DependencyProperty 对象引用指定的依赖属性。

例外

InvalidOperationException

尝试对密封 DependencyObject 调用 ClearValue(DependencyProperty)。

示例

以下示例循环访问对象上设置了本地值的所有属性，然后调用 ClearValue 以清除每个此类属性的值。

void RestoreDefaultProperties(object sender, RoutedEventArgs e)
{
    UIElementCollection uic = Sandbox.Children;
    foreach (Shape uie in uic)
    {
        LocalValueEnumerator locallySetProperties = uie.GetLocalValueEnumerator();
        while (locallySetProperties.MoveNext())
        {
            DependencyProperty propertyToClear = locallySetProperties.Current.Property;
            if (!propertyToClear.ReadOnly) { uie.ClearValue(propertyToClear); }
        }
    }
}

Private Sub RestoreDefaultProperties(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim uic As UIElementCollection = Sandbox.Children
    For Each uie As Shape In uic
        Dim locallySetProperties As LocalValueEnumerator = uie.GetLocalValueEnumerator()
        While locallySetProperties.MoveNext()
            Dim propertyToClear As DependencyProperty = locallySetProperties.Current.Property
            If Not propertyToClear.ReadOnly Then
                uie.ClearValue(propertyToClear)
            End If
        End While
    Next
End Sub

注解

通过调用 ClearValue 清除属性值不一定为依赖属性提供依赖属性元数据中指定的默认值。 清除属性仅专门清除可能已应用的任何本地值。 有关详细信息，请参阅依赖属性值优先级。

另请参阅

• SetValue(DependencyProperty, Object)
• IsSealed
• DependencyProperty

ClearValue(DependencyPropertyKey)

清除只读属性的本地值。 要清除的属性由 DependencyPropertyKey 指定。

public:
 void ClearValue(System::Windows::DependencyPropertyKey ^ key);

public void ClearValue (System.Windows.DependencyPropertyKey key);

member this.ClearValue : System.Windows.DependencyPropertyKey -> unit

Public Sub ClearValue (key As DependencyPropertyKey)

参数

key

DependencyPropertyKey

要清除的依赖属性的关键字。

例外

InvalidOperationException

尝试对密封 DependencyObject 调用 ClearValue(DependencyProperty)。

注解

标识 DependencyPropertyKey 属性系统操作的只读依赖属性。 定义只读依赖属性的类不应公开具有公共访问权限的此密钥。 公开的键将提供一个公共代码路径，该路径可否定属性的只读字符，前提是可以在类或程序集外部调用方法（如 ClearValue 或 SetValue ），并引用该键。

通过调用 ClearValue 清除属性值不一定为依赖属性提供依赖属性元数据中指定的默认值。 清除该值仅专门清除可能已应用的任何本地值。 有关详细信息，请参阅依赖属性值优先级。

另请参阅

• SetValue(DependencyProperty, Object)
• DependencyPropertyKey