C# Class VVVV.Packs.Messaging.MessageFormularRegistry

Mostrar archivo Open project: velcrome/vvvv-Message

Protected Properties

Property Type Description
Data List>.Dictionary

Public Methods

Method Description
Define ( string definerId, MessageFormular formular, bool supressEvent = false ) : bool

Tries to define a Formular. Each named Formular can only be defined by one sender entity

Setting the supressEvent parameter to true will prevent this method to inform any TypeChanged subscribers.

GetFormularsFrom ( string definerId ) : IEnumerable

Retrieve all currently defined Formulars of a specific sender entity

Undefine ( string definerId, MessageFormular formular ) : bool

Unregisters a specific Formular from a specific definer source

UndefineAll ( string definerId ) : bool

Unregisters all Formulars from a specific definer source

this ( string formularName ) : MessageFormular

Retrieve the currently defined Formular by name, regardless of the Definer

Private Methods

Method Description
MessageFormularRegistry ( ) : System

Method Details

Define() public method

Tries to define a Formular. Each named Formular can only be defined by one sender entity
Setting the supressEvent parameter to true will prevent this method to inform any TypeChanged subscribers.
Thrown when the Formular is null. This exception is thrown if a syntax error prevents the config to be parsed.
public Define ( string definerId, MessageFormular formular, bool supressEvent = false ) : bool
definerId string A unique string that helps to keep track, who registered a given Formular.
formular MessageFormular A MessageFormular to be registered.
supressEvent bool A bool indicating if the registry should skip informing interested parties about this change.
return bool

GetFormularsFrom() public method

Retrieve all currently defined Formulars of a specific sender entity
public GetFormularsFrom ( string definerId ) : IEnumerable
definerId string
return IEnumerable

Undefine() public method

Unregisters a specific Formular from a specific definer source
public Undefine ( string definerId, MessageFormular formular ) : bool
definerId string
formular MessageFormular
return bool

UndefineAll() public method

Unregisters all Formulars from a specific definer source
public UndefineAll ( string definerId ) : bool
definerId string
return bool

this() public method

Retrieve the currently defined Formular by name, regardless of the Definer
public this ( string formularName ) : MessageFormular
formularName string
return MessageFormular

Property Details

Data protected_oe property

protected Dictionary> Data
return List>.Dictionary