DependencyObject.ClearValue Method

Definition

清除屬性的區域數值。Clears the local value of a property.

Overloads

ClearValue(DependencyProperty)

清除屬性的區域數值。Clears the local value of a property. 要清除的屬性是由 DependencyProperty 識別項所指定。The property to be cleared is specified by a DependencyProperty identifier.

ClearValue(DependencyPropertyKey)

清除唯讀屬性的區域數值。Clears the local value of a read-only property. 要清除的屬性是由 DependencyPropertyKey 所指定。The property to be cleared is specified by a DependencyPropertyKey.

ClearValue(DependencyProperty)

清除屬性的區域數值。Clears the local value of a property. 要清除的屬性是由 DependencyProperty 識別項所指定。The property to be cleared is specified by a DependencyProperty identifier.

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)

Parameters

dp
DependencyProperty

要清除的相依性屬性,該屬性是由 DependencyProperty 物件參考所識別。The dependency property to be cleared, identified by a DependencyProperty object reference.

Exceptions

Examples

下列範例會逐一查看在物件上設定本機值的所有屬性,然後呼叫 ClearValue 以清除每個這類屬性的值。The following example iterates all properties that have local values set on an object, then calls ClearValue to clear the values of each such property.

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

Remarks

藉由呼叫 ClearValue 來清除屬性值,不一定會將相依性屬性中繼資料中指定的預設值提供給相依性屬性。Clearing the property value by calling ClearValue does not necessarily give a dependency property the default value that is specified in the dependency property metadata. 清除屬性只會明確清除可能已套用的任何本機值。Clearing the property only specifically clears whatever local value may have been applied. 如需詳細資訊,請參閱相依性屬性值優先順序For more information, see Dependency Property Value Precedence.

See also

ClearValue(DependencyPropertyKey)

清除唯讀屬性的區域數值。Clears the local value of a read-only property. 要清除的屬性是由 DependencyPropertyKey 所指定。The property to be cleared is specified by a 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)

Parameters

key
DependencyPropertyKey

要清除之相依性屬性的索引鍵。The key for the dependency property to be cleared.

Exceptions

Remarks

DependencyPropertyKey 可識別屬性系統作業的唯讀相依性屬性。A DependencyPropertyKey identifies a read-only dependency property for property system operations. 定義唯讀相依性屬性的類別不應公開此具有公用存取權的金鑰。Classes that define read-only dependency properties should not expose this key with public access. 如果可以在參考索引鍵的類別或元件外部呼叫 ClearValueSetValue 等方法,公開的索引鍵會提供一個否定屬性唯讀字元的公用程式代碼路徑。A publicly exposed key would provide a public code pathway that negated the read-only character of the property, if methods such as ClearValue or SetValue could be called outside the class or assembly, referencing the key.

藉由呼叫 ClearValue 來清除屬性值,不一定會將相依性屬性中繼資料中指定的預設值提供給相依性屬性。Clearing the property value by calling ClearValue does not necessarily give a dependency property the default value that is specified in the dependency property metadata. 清除此值只會明確清除可能已套用的任何區域值。Clearing the value only specifically clears whatever local value may have been applied. 如需詳細資訊,請參閱相依性屬性值優先順序For more information, see Dependency Property Value Precedence.

See also

Applies to