CustomProperty Class |
Represents a property for a Visual that has been added by the user.
Custom properties can be listened to for changes and also bound to tags for emulation purposes.
Inheritance HierarchySystemObject
SystemEventArgs
System.ComponentModelPropertyChangedEventArgs
Demo3D.VisualsBindableItem
Demo3D.UtilitiesCustomProperty
SystemEventArgs
System.ComponentModelPropertyChangedEventArgs
Demo3D.VisualsBindableItem
Demo3D.UtilitiesCustomProperty
Namespace: Demo3D.Utilities
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 18.03.00
SyntaxC#
public sealed class CustomProperty : BindableItem, ICloneable
The CustomProperty type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllowedAccess |
Returns the allowed access for external IO on this item.
(Inherited from BindableItem.) |
| AutoGenerated | This custom property is generated and shouldn't be deleted by the user. |
| BindingInterface |
Gets/sets if the bindable item has a declared binding interface.
Normally, aspects manage the BAPI themselves.
(Inherited from BindableItem.) |
| Category | The category for the custom property (Defaults to CustomProperty.DefaultCategory). |
| DefaultAccess |
Returns the default access for external IO on this item.
(Inherited from BindableItem.) |
| Description | The description of the custom property. |
| Expression |
Returns the full expression of the item.
Includes the full name of the associated visual and the binding name.
(Inherited from BindableItem.) |
| HasBindingInterface |
Returns true if the bindable item has a declared binding interface.
(Inherited from BindableItem.) |
| Hidden | Whether the custom property is hidden in the user interface or not. |
| InitialExpression | Gets or sets an expression for the initial value of this custom property. |
| IOControl |
Gets or sets a property to control how individual updates to this item are presented externally.
(Inherited from BindableItem.) |
| IsBindingInterface |
Declares a bindable item as part of the binding interface for a component.
Yes: Bindable item is definitely part of the API.
Maybe: Bindable item may be part of the API.
No: Bindable item is definitely not part of the API.
(Inherited from BindableItem.) |
| IsBound |
Returns true if this item is bound to a server item in the TagBrowser.
(Inherited from BindableItem.) |
| Name | Name of the custom property |
| Persistent | Should the custom property be written to disk. |
| ReadOnly | Whether the custom property can be edited in the user interface or not. |
| Type |
The declared .Net type of the item.
(Inherited from BindableItem.) |
| UpdatedScript | Occurs whenever the custom property value changes. |
| Value |
Gets or sets the value of the item.
(Inherited from BindableItem.) |
Methods| Name | Description | |
|---|---|---|
 | Clone |
Create a clone of the custom property.
(Overrides BindableItemClone.) |
| Equals | (Inherited from BindableItem.) |
| Force |
Force the value.
(Inherited from BindableItem.) |
| SetValueT |
Sets the value of the item.
(Inherited from BindableItem.) |
| ToString |
Name of the custom property.
(Overrides BindableItemToString.) |
| UnForce |
Unforce the value.
(Inherited from BindableItem.) |
| UnforcedValueAsT |
Cast the UnforcedValue to a specific type if necessary.
(Inherited from BindableItem.) |
| UnforcedValueIsT |
Test whether the UnforcedValue is of the given type.
(Inherited from BindableItem.) |
| ValueAsT |
Cast the value to a specific type if necessary.
(Inherited from BindableItem.) |
| ValueIsT |
Test whether the Value is of the given type.
(Inherited from BindableItem.) |
Events| Name | Description | |
|---|---|---|
 | ExpressionChanged |
Occurs when the Expression changes. For example if the associated visual's name changes.
(Inherited from BindableItem.) |
| UnforcedValueChanged |
Occurs when the unforced value of the item changes.
(Inherited from BindableItem.) |
| ValueChanged |
Occurs when the value of the item changes.
(Inherited from BindableItem.) |
Fields| Name | Description | |
|---|---|---|
  | DefaultCategory | The default category name to be used when creating new custom properties. |
| Owner |
Extension Methods| Name | Description | |
|---|---|---|
 | IsBound |
True if the specified serverItem and bindableItem are bound by some expression.
(Defined by CTScript.) |
| RemoveBindings |
Remove existing bindings and server items for bindable item.
(Defined by CTScript.) |
See Also