DependencyProperty.RegisterAttached Метод

Определение

Регистрирует присоединенное свойство в системе свойств.Registers an attached property with the property system.

Перегрузки

RegisterAttached(String, Type, Type)

Регистрирует присоединенное свойство с указанием имени свойства, типа свойства и типа владельца.Registers an attached property with the specified property name, property type, and owner type.

RegisterAttached(String, Type, Type, PropertyMetadata)

Регистрирует присоединенное свойство с указанным именем и типом свойства, типом владельца и метаданными свойства.Registers an attached property with the specified property name, property type, owner type, and property metadata.

RegisterAttached(String, Type, Type, PropertyMetadata, ValidateValueCallback)

Регистрирует присоединенное свойство с указанным типом свойства, типом владельца, метаданными свойства и обратным вызовом для проверки значения свойства.Registers an attached property with the specified property type, owner type, property metadata, and value validation callback for the property.

RegisterAttached(String, Type, Type)

Регистрирует присоединенное свойство с указанием имени свойства, типа свойства и типа владельца.Registers an attached property with the specified property name, property type, and owner type.

public:
 static System::Windows::DependencyProperty ^ RegisterAttached(System::String ^ name, Type ^ propertyType, Type ^ ownerType);
public static System.Windows.DependencyProperty RegisterAttached (string name, Type propertyType, Type ownerType);
static member RegisterAttached : string * Type * Type -> System.Windows.DependencyProperty
Public Shared Function RegisterAttached (name As String, propertyType As Type, ownerType As Type) As DependencyProperty

Параметры

name
String

Имя регистрируемого свойства зависимостей.The name of the dependency property to register.

propertyType
Type

Тип свойства.The type of the property.

ownerType
Type

Тип владельца, регистрирующего свойство зависимостей.The owner type that is registering the dependency property.

Возвраты

Идентификатор свойства зависимостей, который должен использоваться для задания значения поля public static readonly в классе.A dependency property identifier that should be used to set the value of a public static readonly field in your class. Затем этот идентификатор используется для ссылки на свойство зависимостей для операций, например задания значения программным образом или получение метаданных.That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

Примеры

В следующем примере вложенное свойство регистрируется для абстрактного класса с помощью подписи RegisterAttached.The following example registers an attached property on an abstract class using this RegisterAttached signature.

public static readonly DependencyProperty IsBubbleSourceProperty = DependencyProperty.RegisterAttached(
  "IsBubbleSource",
  typeof(Boolean),
  typeof(AquariumObject2)
);
public static void SetIsBubbleSource(UIElement element, Boolean value)
{
    element.SetValue(IsBubbleSourceProperty, value);
}
public static Boolean GetIsBubbleSource(UIElement element)
{
    return (Boolean)element.GetValue(IsBubbleSourceProperty);
}
Public Shared ReadOnly IsBubbleSourceProperty As DependencyProperty = DependencyProperty.RegisterAttached("IsBubbleSource", GetType(Boolean), GetType(AquariumObject2))
Public Shared Sub SetIsBubbleSource(ByVal element As UIElement, ByVal value As Boolean)
    element.SetValue(IsBubbleSourceProperty, value)
End Sub
Public Shared Function GetIsBubbleSource(ByVal element As UIElement) As Boolean
    Return CType(element.GetValue(IsBubbleSourceProperty), Boolean)
End Function

Комментарии

Присоединенное свойство — это понятие свойства, определяемое Язык XAMLExtensible Application Markup Language (XAML).An attached property is a property concept defined by Язык XAMLExtensible Application Markup Language (XAML). WPFWPF реализует присоединенные свойства в качестве свойств зависимостей.implements attached properties as dependency properties. Поскольку вложенные свойства WPFWPF являются свойствами зависимостей, к ним могут применяться метаданные, которые могут использоваться общей системой свойств для таких операций, как отчеты о характеристиках макета.Because the WPFWPF attached properties are dependency properties, they can have metadata applied that can be used by the general property system for operations such as reporting layout characteristics. Дополнительные сведения см. в разделе Общие сведения о вложенных свойствах.For more information, see Attached Properties Overview.

Дополнительные сведения о регистрации свойств зависимостей см. в разделе DependencyProperty.For more information on dependency property registration, see DependencyProperty.

Дополнительно

RegisterAttached(String, Type, Type, PropertyMetadata)

Регистрирует присоединенное свойство с указанным именем и типом свойства, типом владельца и метаданными свойства.Registers an attached property with the specified property name, property type, owner type, and property metadata.

public:
 static System::Windows::DependencyProperty ^ RegisterAttached(System::String ^ name, Type ^ propertyType, Type ^ ownerType, System::Windows::PropertyMetadata ^ defaultMetadata);
public static System.Windows.DependencyProperty RegisterAttached (string name, Type propertyType, Type ownerType, System.Windows.PropertyMetadata defaultMetadata);
static member RegisterAttached : string * Type * Type * System.Windows.PropertyMetadata -> System.Windows.DependencyProperty
Public Shared Function RegisterAttached (name As String, propertyType As Type, ownerType As Type, defaultMetadata As PropertyMetadata) As DependencyProperty

Параметры

name
String

Имя регистрируемого свойства зависимостей.The name of the dependency property to register.

propertyType
Type

Тип свойства.The type of the property.

ownerType
Type

Тип владельца, регистрирующего свойство зависимостей.The owner type that is registering the dependency property.

defaultMetadata
PropertyMetadata

Метаданные свойства зависимостей.Property metadata for the dependency property. Могут включать значение по умолчанию и другие характеристики.This can include the default value as well as other characteristics.

Возвраты

Идентификатор свойства зависимостей, который должен использоваться для задания значения поля public static readonly в классе.A dependency property identifier that should be used to set the value of a public static readonly field in your class. Затем этот идентификатор используется для ссылки на свойство зависимостей для операций, например задания значения программным образом или получение метаданных.That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

Комментарии

Присоединенное свойство — это понятие свойства, определяемое Язык XAMLExtensible Application Markup Language (XAML).An attached property is a property concept defined by Язык XAMLExtensible Application Markup Language (XAML). WPFWPF реализует присоединенные свойства в качестве свойств зависимостей.implements attached properties as dependency properties. Поскольку вложенные свойства WPFWPF являются свойствами зависимостей, к ним могут применяться метаданные, которые могут использоваться общей системой свойств для таких операций, как отчеты о характеристиках макета.Because the WPFWPF attached properties are dependency properties, they can have metadata applied that can be used by the general property system for operations such as reporting layout characteristics. Дополнительные сведения см. в разделе Общие сведения о вложенных свойствах.For more information, see Attached Properties Overview.

Дополнительные сведения о регистрации свойств зависимостей см. в разделе DependencyProperty.For more information on dependency property registration, see DependencyProperty.

Использование RegisterAttached для наследования значений свойств зависимостейUse RegisterAttached for Value-inheriting Dependency Properties

Одним из сценариев регистрации свойства зависимостей с RegisterAttached вместо Register является поддержка наследования значения свойства.One particular scenario for registering a dependency property with RegisterAttached instead of Register is to support property value inheritance. Следует регистрировать свойства зависимостей, наследуемые значениями, с RegisterAttached даже если класс определяет методы доступа к оболочке свойств, которые предоставляют свойство зависимостей, и даже если вы не собираетесь предоставлять статические методы get * и Set * для предоставления истинных вложений методы доступа для поддержки свойств.You should register value-inheriting dependency properties with RegisterAttached even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Несмотря на то, что наследование значений свойств может работать для неприсоединенных свойств зависимостей, поведение наследования для неприсоединенного свойства через определенные границы элементов в дереве среды выполнения не определено.Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Регистрация свойства как присоединенного фактически делает присоединенное свойство глобальным свойством системы свойств и гарантирует, что наследование значения свойства работает во всех границах дерева элементов.Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Всегда используйте RegisterAttached для регистрации свойств, в которых указываются Inherits в метаданных.Always use RegisterAttached to register properties where you specify Inherits in the metadata. Дополнительные сведения см. в разделе Наследование значения свойства.For more information, see Property Value Inheritance.

Дополнительно

RegisterAttached(String, Type, Type, PropertyMetadata, ValidateValueCallback)

Регистрирует присоединенное свойство с указанным типом свойства, типом владельца, метаданными свойства и обратным вызовом для проверки значения свойства.Registers an attached property with the specified property type, owner type, property metadata, and value validation callback for the property.

public:
 static System::Windows::DependencyProperty ^ RegisterAttached(System::String ^ name, Type ^ propertyType, Type ^ ownerType, System::Windows::PropertyMetadata ^ defaultMetadata, System::Windows::ValidateValueCallback ^ validateValueCallback);
public static System.Windows.DependencyProperty RegisterAttached (string name, Type propertyType, Type ownerType, System.Windows.PropertyMetadata defaultMetadata, System.Windows.ValidateValueCallback validateValueCallback);
static member RegisterAttached : string * Type * Type * System.Windows.PropertyMetadata * System.Windows.ValidateValueCallback -> System.Windows.DependencyProperty

Параметры

name
String

Имя регистрируемого свойства зависимостей.The name of the dependency property to register.

propertyType
Type

Тип свойства.The type of the property.

ownerType
Type

Тип владельца, регистрирующего свойство зависимостей.The owner type that is registering the dependency property.

defaultMetadata
PropertyMetadata

Метаданные свойства зависимостей.Property metadata for the dependency property. Могут включать значение по умолчанию и другие характеристики.This can include the default value as well as other characteristics.

validateValueCallback
ValidateValueCallback

Ссылка на обратный вызов, который должен выполнить пользовательскую проверку значения свойства зависимостей после обычной проверки типа.A reference to a callback that should perform any custom validation of the dependency property value beyond typical type validation.

Возвраты

Идентификатор свойства зависимостей, который должен использоваться для задания значения поля public static readonly в классе.A dependency property identifier that should be used to set the value of a public static readonly field in your class. Затем этот идентификатор используется для ссылки на свойство зависимостей для операций, например задания значения программным образом или получение метаданных.That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

Примеры

В следующем примере вложенное свойство регистрируется для абстрактного класса с помощью подписи RegisterAttached.The following example registers an attached property on an abstract class using this RegisterAttached signature. Это присоединенное свойство является свойством типа перечисления, и регистрация добавляет обратный вызов проверки, чтобы убедиться, что предоставленное значение является значением перечисления.This attached property is an enumeration type property, and the registration adds a validation callback to verify that the provided value is a value of the enumeration.

public static readonly DependencyProperty IsBubbleSourceProperty = DependencyProperty.RegisterAttached(
  "IsBubbleSource",
  typeof(Boolean),
  typeof(AquariumObject2)
);
public static void SetIsBubbleSource(UIElement element, Boolean value)
{
    element.SetValue(IsBubbleSourceProperty, value);
}
public static Boolean GetIsBubbleSource(UIElement element)
{
    return (Boolean)element.GetValue(IsBubbleSourceProperty);
}
Public Shared ReadOnly IsBubbleSourceProperty As DependencyProperty = DependencyProperty.RegisterAttached("IsBubbleSource", GetType(Boolean), GetType(AquariumObject2))
Public Shared Sub SetIsBubbleSource(ByVal element As UIElement, ByVal value As Boolean)
    element.SetValue(IsBubbleSourceProperty, value)
End Sub
Public Shared Function GetIsBubbleSource(ByVal element As UIElement) As Boolean
    Return CType(element.GetValue(IsBubbleSourceProperty), Boolean)
End Function

Комментарии

Присоединенное свойство — это понятие свойства, определяемое Язык XAMLExtensible Application Markup Language (XAML).An attached property is a property concept defined by Язык XAMLExtensible Application Markup Language (XAML). WPFWPF реализует присоединенные свойства в качестве свойств зависимостей.implements attached properties as dependency properties. Поскольку вложенные свойства WPFWPF являются свойствами зависимостей, к ним могут применяться метаданные, которые могут использоваться общей системой свойств для таких операций, как отчеты о характеристиках макета.Because the WPFWPF attached properties are dependency properties, they can have metadata applied that can be used by the general property system for operations such as reporting layout characteristics. Дополнительные сведения см. в разделе Общие сведения о вложенных свойствах.For more information, see Attached Properties Overview.

Дополнительные сведения о регистрации свойств зависимостей см. в разделе DependencyProperty.For more information on dependency property registration, see DependencyProperty.

Использование RegisterAttached для наследования значений свойств зависимостейUse RegisterAttached for Value-inheriting Dependency Properties

Одним из сценариев регистрации свойства зависимостей с RegisterAttached вместо Register является поддержка наследования значения свойства.One particular scenario for registering a dependency property with RegisterAttached instead of Register is to support property value inheritance. Следует регистрировать свойства зависимостей, наследуемые значениями, с RegisterAttached даже если класс определяет методы доступа к оболочке свойств, которые предоставляют свойство зависимостей, и даже если вы не собираетесь предоставлять статические методы get * и Set * для предоставления истинных вложений методы доступа для поддержки свойств.You should register value-inheriting dependency properties with RegisterAttached even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Несмотря на то, что наследование значений свойств может работать для неприсоединенных свойств зависимостей, поведение наследования для неприсоединенного свойства через определенные границы элементов в дереве среды выполнения не определено.Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Регистрация свойства как присоединенного фактически делает присоединенное свойство глобальным свойством системы свойств и гарантирует, что наследование значения свойства работает во всех границах дерева элементов.Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Всегда используйте RegisterAttached для регистрации свойств, в которых указываются Inherits в метаданных.Always use RegisterAttached to register properties where you specify Inherits in the metadata. Дополнительные сведения см. в разделе Наследование значения свойства.For more information, see Property Value Inheritance.

Дополнительно

Применяется к