Kanzi 4.1.0
TypedProperty< T > Interface Template Reference

A generic property type interface that provides type-safe access to property default values. More...

Inheritance diagram for TypedProperty< T >:
[legend]
Collaboration diagram for TypedProperty< T >:
[legend]

Properties

T DefaultValueTyped [get, set]
 Gets or sets the default value of the property type with its native type.
 
- Properties inherited from Property
bool AffectLayout [get, set]
 Gets or sets whether the property affects node layout.
 
bool AffectRender [get, set]
 Gets or sets whether the property affects node rendering.
 
string Category [get, set]
 Gets or sets the category in which Kanzi Studio shows the property type in the Properties and Add Properties windows.
 
Type DataType [get]
 Gets the data type of the property type.
 
object DefaultValue [get, set]
 Gets or sets the default value of the property type.
 
string Description [get, set]
 Gets or sets the description of the purpose the property type.
 
string DisplayName [get, set]
 Gets or sets the name of the property type the way Kanzi Studio shows it.
 
PropertyEditor Editor [get, set]
 Gets or sets the editor that lets Kanzi Studio users set the value of the property in the Properties window.
 
bool IsCustomOrPluginPropertyType [get]
 Gets whether the property type is a custom property type created in Kanzi Studio or a property type defined in a Kanzi Studio plugin.
 
bool IsHidden [get, set]
 Gets or sets whether Kanzi Studio hides the property type in the Add Properties window and Add Property context menu.
 
bool IsInherited [get, set]
 Gets or sets whether nodes can inherit from their ancestor nodes the value of this property.
 
bool IsMessageArgument [get]
 Gets whether you can use the property type as an argument of an action in Kanzi Studio.
 
bool IsVisibleToRuntime [get, set]
 Gets or sets whether Kanzi Studio exports the property to Kanzi Engine.
 
string LocalName [get]
 Gets the name of the property type without the property type namespace.
 
string Name [get, set]
 Gets or sets the name of the property type.
 
PropertyReadOnlyStatus ReadOnlyStatus [get]
 Gets a status that tells you whether the property type can be modified.
 
intSortingIndex [get, set]
 Gets or sets the sorting index of the property.
 
string ToolTip [get, set]
 Gets or sets the tooltip that Kanzi Studio shows for the property type in the Properties and Add Properties windows.
 
IEnumerable< TypeUserAddableHostTypes [get, set]
 Gets or sets the node types to which Kanzi Studio users can add this property.
 

Additional Inherited Members

- Public Member Functions inherited from Property
IEnumerable< PropertyEditorGetCompatiblePropertyEditors ()
 Gets the property editors that are compatible with this property type.
 

Detailed Description

A generic property type interface that provides type-safe access to property default values.

Template Parameters
TThe data type of the property value.
See also
Property, IntProperty, FloatProperty, Vector2DProperty, Vector3DProperty, Vector4DProperty, CustomEnumProperty

Property Documentation

◆ DefaultValueTyped

T DefaultValueTyped
getset

Gets or sets the default value of the property type with its native type.

See also
Property.DefaultValue