ICustomProperty
ICustomProperty
ICustomProperty
ICustomProperty
Interface
Definition
Implements custom property definition support for data binding sources that are implemented using COM.
public : interface ICustomPropertypublic interface ICustomPropertyPublic Interface ICustomProperty// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
ICustomProperty represents a property on an instance of an object, but the calling patterns support the ability to implement the interface per owner type.
Properties
CanRead CanRead CanRead CanRead
Gets a value that determines whether the custom property supports read access.
public : PlatForm::Boolean CanRead { get; }public bool CanRead { get; }Public ReadOnly Property CanRead As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the property value can be read as a data source. false if the property cannot be a data source value.
CanWrite CanWrite CanWrite CanWrite
Gets a value that determines whether the custom property supports write access.
public : PlatForm::Boolean CanWrite { get; }public bool CanWrite { get; }Public ReadOnly Property CanWrite As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the value can be written to through a data source relationship in a two-way binding. false if the property cannot be written to.
Name Name Name Name
Gets the path-relevant name of the property.
public : PlatForm::String Name { get; }public string Name { get; }Public ReadOnly Property Name As string// This API is not available in Javascript.
- Value
- PlatForm::String string string string
The name of the property as it would be specified in a binding expression.
Methods
GetIndexedValue(Object, Object) GetIndexedValue(Object, Object) GetIndexedValue(Object, Object) GetIndexedValue(Object, Object)
Gets the value at an index location, for cases where the custom property has indexer support.
public : PlatForm::Object GetIndexedValue(PlatForm::Object target, PlatForm::Object index)public object GetIndexedValue(Object target, Object index)Public Function GetIndexedValue(target As Object, index As Object) As object// This API is not available in Javascript.
- target
- PlatForm::Object Object Object Object
The owning instance.
- index
- PlatForm::Object Object Object Object
The index to get.
The retrieved value at the index.
GetValue(Object) GetValue(Object) GetValue(Object) GetValue(Object)
Gets the value of the custom property from a particular instance.
public : PlatForm::Object GetValue(PlatForm::Object target)public object GetValue(Object target)Public Function GetValue(target As Object) As object// This API is not available in Javascript.
- target
- PlatForm::Object Object Object Object
The owning instance.
The retrieved value.
SetIndexedValue(Object, Object, Object) SetIndexedValue(Object, Object, Object) SetIndexedValue(Object, Object, Object) SetIndexedValue(Object, Object, Object)
Sets the value at an index location, for cases where the custom property has indexer support.
public : void SetIndexedValue(PlatForm::Object target, PlatForm::Object value, PlatForm::Object index)public void SetIndexedValue(Object target, Object value, Object index)Public Function SetIndexedValue(target As Object, value As Object, index As Object) As void// This API is not available in Javascript.
- target
- PlatForm::Object Object Object Object
The owner instance.
- value
- PlatForm::Object Object Object Object
The value to set.
- index
- PlatForm::Object Object Object Object
The index location to set to.
SetValue(Object, Object) SetValue(Object, Object) SetValue(Object, Object) SetValue(Object, Object)
Sets the custom property value on a specified instance.
public : void SetValue(PlatForm::Object target, PlatForm::Object value)public void SetValue(Object target, Object value)Public Function SetValue(target As Object, value As Object) As void// This API is not available in Javascript.
- target
- PlatForm::Object Object Object Object
The owner instance.
- value
- PlatForm::Object Object Object Object
The value to set.