Interface IProperty<T>

A property handle containing functionality for one property

interface IProperty<T> {
    DefaultStorage: IDefaultValueStorage<T>;
    Getter: TGet<T>;
    Info: IPropertyInfo;
    Owner: cComponentBase;
    Setter: TSet<T>;
    Get(): T;
    OnChange(listener: TPropertyListener): void;
    RemoveChangeListener(listener: TPropertyListener): void;
    Set(value: T, noevent?: boolean): void;
    SetAttributes(attributes: IPropertyConfig): void;
    SetDefaultValue(value: T, initialconfig?: IComponentConfig): void;
}

Type Parameters

T

Hierarchy (View Summary)

IAnyProperty
- IProperty

Index

Properties

DefaultStorage Getter Info Owner Setter

Methods

Get OnChange RemoveChangeListener Set SetAttributes SetDefaultValue

Properties

`Readonly`DefaultStorage

DefaultStorage: IDefaultValueStorage<T>

The default value storage

Getter

Getter: TGet<T>

The getter function - overrides the default property getter.

`Readonly`Info

Info: IPropertyInfo

The attributes of the property

`Readonly`Owner

Owner: cComponentBase

The component containing the property.

Setter

Setter: TSet<T>

The setter function - overrides the default property setter.

Methods

Get

Get(): T
Get the property value

Returns T
- Defined in mia/ts/componentbase/propertyapi.ts:12

OnChange

OnChange(listener: TPropertyListener): void
Adds a property change listener.
Parameters
- listener: TPropertyListener
  A function that is called when a property value is changed (the property name is passed as a parameter to the function).
Returns void
Inherited from IAnyProperty.OnChange
- Defined in mia/ts/componentbase/propertyapi.ts:40

RemoveChangeListener

RemoveChangeListener(listener: TPropertyListener): void
Removes a property change listener.
Parameters
- listener: TPropertyListener
  The function to be removed.
Returns void
Inherited from IAnyProperty.RemoveChangeListener
- Defined in mia/ts/componentbase/propertyapi.ts:45

Set

Set(value: T, noevent?: boolean): void
Set the property value
Parameters
- value: T
  New value for the property
- Optionalnoevent: boolean
  Do not raise the PropertyChanged (IPropertyAPI.Changed) event
Returns void
- Defined in mia/ts/componentbase/propertyapi.ts:28

SetAttributes

SetAttributes(attributes: IPropertyConfig): void
Modifies one or several attributes of a property.
Parameters
- attributes: IPropertyConfig
  Attributes with their new values.
Returns void
Inherited from IAnyProperty.SetAttributes
- Defined in mia/ts/componentbase/propertyapi.ts:50

SetDefaultValue

SetDefaultValue(value: T, initialconfig?: IComponentConfig): void
Sets the default value for a property - useful for overriding defaults defined in base component.
Parameters
- value: T
  New default value
- Optionalinitialconfig: IComponentConfig
  Initial configuration for the component
Returns void
- Defined in mia/ts/componentbase/propertyapi.ts:20