DependencyProperty.Register Метод

Определение

Пространство имен:

Microsoft.UI.Xaml

Регистрирует свойство зависимостей с указанным именем свойства, типом свойства, типом владельца и метаданными свойства для свойства. Используйте этот метод при определении или инициализации производного класса DependencyObject , которому будет принадлежать зарегистрированное свойство зависимости.

 static DependencyProperty Register(winrt::hstring const& name, TypeName const& propertyType, TypeName const& ownerType, PropertyMetadata const& typeMetadata);

public static DependencyProperty Register(string name, System.Type propertyType, System.Type ownerType, PropertyMetadata typeMetadata);

function register(name, propertyType, ownerType, typeMetadata)

Public Shared Function Register (name As String, propertyType As Type, ownerType As Type, typeMetadata As PropertyMetadata) As DependencyProperty

Параметры

name

String

winrt::hstring

Имя регистрируемого свойства зависимостей.

propertyType

TypeName Type

Тип свойства в качестве ссылки на тип (System.Type для Microsoft .NET, вспомогательная структуру TypeName для расширений компонентов Visual C++ (C++/CX)).

ownerType

TypeName Type

Тип владельца, регистрирующий свойство зависимостей в качестве ссылки на тип (System.Type для Microsoft .NET, вспомогательная структуру TypeName для расширений компонентов Visual C++ (C++/CX)).

typeMetadata

PropertyMetadata

Экземпляр метаданных свойства. Он может содержать значение по умолчанию и ссылку на реализацию PropertyChangedCallback . Передача null для этого параметра эквивалентна передаче нового экземпляра PropertyMetadata, созданного путем вызова PropertyMetadata.Create с null в качестве параметра значения по умолчанию.

Возвращаемое значение

DependencyProperty

Идентификатор свойства зависимостей, который обычно хранится в общедоступном статическом поле только для чтения в производном классе DependencyObject . Затем идентификатор используется как вашим собственным кодом, так и любым сторонним пользовательским кодом для последующей ссылки на свойство зависимостей для таких операций, как установка его значения программными средствами или присоединение привязки в коде.

Комментарии

Подробное описание регистрации настраиваемого свойства зависимостей (с примерами) см. в разделе Пользовательские свойства зависимостей.

Регистрация свойства зависимостей обычно выполняется только при первом запуске приложения или при первом использовании производных классов DependencyObject , определенных в коде приложения. Необходимо зарегистрировать свойства зависимостей в начале времени существования приложения, чтобы гарантировать, что другой код и XAML в приложении не будут пытаться использовать свойства зависимостей до их регистрации и доступности. Способ и время регистрации зависит от языка программирования. Для C# или Microsoft Visual Basic свойства зависимостей обычно регистрируются во время инициализации статического класса класса, которому принадлежит свойство зависимости. Таким образом, любой код или XAML, который инициализирует экземпляр, будет вызывать статическую конструкцию и регистрировать свойство зависимости. Для расширений компонентов Visual C++ (C++/CX)инициализация статических классов не является доступной методикой, поэтому обычно необходимо определить вспомогательный метод для всего приложения, который регистрирует все пользовательские свойства зависимостей, которые ваше приложение намерено использовать, в рамках инициализации объекта приложения . Примеры того, как и когда регистрировать пользовательские свойства зависимостей, включая некоторые специальные методы, необходимые для расширений компонентов Visual C++ (C++/CX), см. в разделе Пользовательские свойства зависимостей.

См. также раздел

• Пользовательские свойства зависимостей
• Общие сведения о свойствах зависимостей
• Пример пользовательских и настраиваемых элементов управления XAML