PropertyStore Class

A storage for properties and events of a class

Inheritance Hierarchy

SystemObject
System.Collections.GenericDictionaryObject, Object
EtoPropertyStore

Namespace: Eto
Assembly: Eto (in Eto.dll) Version: 2.5.3-dev

Syntax

Copy

public class PropertyStore : Dictionary<Object, Object>

Public Class PropertyStore
	Inherits Dictionary(Of Object, Object)

type PropertyStore =  
    class
        inherit Dictionary<Object, Object>
    end

The PropertyStore type exposes the following members.

Constructors

	Name	Description
	PropertyStore	Initializes a new instance of the PropertyStore class.

Top

Properties

	Name	Description
	Parent	Gets the parent object that this property store is attached to

Top

Methods

	Name	Description
	AddEvent	Adds a generic event delegate with the specified key
	AddHandlerEvent	Adds a handler-based event delegate with the specified key
	CreateT(Object)	Gets a value from the property store with the specified key of a concrete type, and creates a new instance if it doesn't exist yet.
	CreateT(Object, FuncT)	Gets a value from the property store with the specified key of a concrete type, and creates a new instance if it doesn't exist yet.
	GetT(Object, FuncT)	Gets a value from the property store with the specified key of a concrete type
	GetT(Object, T)	Gets a value from the property store with the specified key of a concrete type
	GetCommand	Gets the command instance for the specified property key.
	RemoveEvent	Removes the event delegate with the specified key
	SetT(Object, T, T)	Set the value for the specified property key, removing the value from the dictionary if it is the default value of T.
	SetT(Object, T, Action, T)	Set the value for the specified property key, calling the propertyChanged delegate if it has changed.
	SetT(Object, T, PropertyChangedEventHandler, T, String)	Set the value for the specified property key, raising the propertyChanged handler if it has changed.
	SetCommand	Sets an ICommand value for the specified property key.
	TriggerEventT	Triggers an event with the specified key
	TrySetT	Set the value for the specified property key, removing the value from the dictionary if it is the default value of T.
	UpdateCommandCanExecute	Updates the command's execute status, typically when the CommandParameter changes.

Top

Remarks

This is used by Widget object to minimize the footprint of each instance. For example, the Control class has around 20 events, each would take up to 4 bytes on a 32 bit system for a total overhead of 80 bytes per instance. Most of the events won't be handled on most controls, so using a dictionary can dramatically reduce the size. This can also be used for rarely used properties that do not need to be extremely performant when getting or setting the value.

Reference

Eto Namespace