Referencia de la clase sage.ew.global.Diccionarios.DiccionarioGlobal

Diccionario de variables globales. Más...

Diagrama de herencia de sage.ew.global.Diccionarios.DiccionarioGlobal

Métodos públicos
	DiccionarioGlobal ()
	Constructor.
void	SetLoader (IDiccionarioGlobalLoader diccionario)
	Inyecta el cargador del diccionario de vables globales.
DataTable	GetAllVariable ()
	PE-103101 Devuelve todas las variables de la GLOBAL cargadas en memoria.
bool	LoadData (string empresa)
	Carga el diccionario de global.
bool	LoadExtra (string rutaXml)
	/// PE-64379. Procedimiento que nos agrega al diccionario de variables globales las indicadas en el xml de la ruta "tcRutaXml" El documento xml debe tener un nodo para cada variable con el siguiente formato:
Métodos públicos heredados de sage.ew.global.Diccionarios.Diccionario< Tkey, Tvalue >
void	SetValueNoChange (Tkey key, Tvalue value)
	Añade la clave y el valor especificado en el diccionario, en caso de que exista no lo modificará
void	SetValue (Tkey key, Tvalue value)
	Añade la clave y el valor especificado en el diccionario, en caso de que exista lo modificará siempre.
bool	ModifyValue (Tkey key, Tvalue value)
	Modifica la clave con el valor indicado. Si la clave no existe no lo añadirá
Tvalue	GetValue (Tkey key)
	Devuelve el valor de la clave del diccionario.
Tvalue	GetValue (Tkey key, Tvalue defaultValue)
	A partir de un nombre de variable devuelve su valor en formato object.
bool	TryGetValue (Tkey key, out Tvalue value)
	Intenta obtener el valor de la clave correspondiente.
bool	Remove (Tkey key)
	Elimina del diccionario el elemento indicado.
int	Count ()
	Numero de elementos del diccionario.
bool	ContainsKey (Tkey key)
	Indica si existe la clave en el diccionario.
bool	ContainsValue (Tvalue value)
	Indica si existe el valor en el diccionario.
void	Clear ()
	Borra el contenido del diccionario.
void	Dispose ()
	Dispose.
Métodos públicos heredados de sage.ew.interficies.Diccionario.IDiccionario< TKey, TValue >
void	SetValue (TKey key, TValue value)
	Añade la clave y el valor especificado en el diccionario Global, en caso de que exista lo modificará siempre.
void	SetValueNoChange (TKey key, TValue value)
	Añade la clave y el valor especificado en el diccionario, en caso de que exista no lo modificará
bool	ModifyValue (TKey key, TValue value)
	Modifica la clave con el valor indicado. Si la clave no existe no lo añadirá
TValue	GetValue (TKey key)
	A partir de un nombre de variable devuelve su valor en formato object.
TValue	GetValue (TKey key, TValue defaultValue)
	A partir de un nombre de variable devuelve su valor en formato object.
bool	Remove (TKey key)
	Elimina del diccionario el elemento indicado.
bool	TryGetValue (TKey key, out TValue value)
	Intenta obtener el valor de la clave correspondiente.
bool	ContainsKey (TKey key)
	Indica si existe la clave en el diccionario.

Métodos protegidos
override void	Internal_SetValue (string key, object value, bool lbSiExiste=true)
	Añade la clave y el valor especificado en el diccionario, en caso de que exista no lo modificará
override object	Internal_GetValue (string key, object defaultValue=null)
	A partir de un nombre de variable devuelve su valor en formato object y si no existe devuelve el default value.
Métodos protegidos heredados de sage.ew.global.Diccionarios.Diccionario< Tkey, Tvalue >
	Diccionario ()
	Constructor.
virtual void	Internal_SetValue (Tkey key, Tvalue value, bool lbSiExiste=true)
	Añade o modifica en el diccionario el valor de la clave. SilbSiExiste es false no lo modifica.
virtual Tvalue	Internal_GetValue (Tkey key)
	Obtiene el valor de la clave del diccionario.
virtual Tvalue	Internal_GetValue (Tkey key, Tvalue defaulValue=default(Tvalue))
	Obtiene el valor de la clave del diccionario si no la encuentra devuelve defaultValue.
virtual bool	Internal_TryGetValue (Tkey key, out Tvalue value)
	Obtiene el valor de la clave del diccionario.
virtual bool	Intenal_ModifyValue (Tkey key, Tvalue value)
	Modifica valor de la clave del diccionario. Si no la encuentra muestra mensaje.
virtual bool	Internal_Remove (Tkey key)
	Elimina la clave del diccionario.
virtual int	Internal_Count ()
	Numero de elementos en el diccionario.
virtual bool	Internal_ContainsKey (Tkey key)
	Si existe clave en el diccionario.
virtual bool	Internal_ContainsValue (Tvalue value)
	Si existe valor en diccionario.
void	Internal_Clear ()
	Limpia el diccionario.
virtual void	OnError (ErrorEventArgs e)
	Lanza evento Error.

Otros miembros heredados
Atributos protegidos heredados de sage.ew.global.Diccionarios.Diccionario< Tkey, Tvalue >
Dictionary< Tkey, Tvalue >	_oDiccionario = new Dictionary<Tkey, Tvalue>()
	diccionario
bool	_dataLoaded = false
	Datos del diccionario cargados.
Propiedades heredados de sage.ew.global.Diccionarios.Diccionario< Tkey, Tvalue >
string	MensajeError [get, protected set]
	Mensaje de error.
bool	HuboError [get, protected set]
	Indica si hubo error al cargar el diccionario.
Eventos heredados de sage.ew.global.Diccionarios.Diccionario< Tkey, Tvalue >
EventHandler	Error
	Evento lanzado si error.
Eventos heredados de sage.ew.interficies.Diccionario.IDiccionario< TKey, TValue >
EventHandler	Error
	Evento de error.

Descripción detallada

Diccionario de variables globales.

Definición en la línea 15 del archivo DiccionarioGlobal.cs.

Documentación de constructores y destructores

DiccionarioGlobal()

sage.ew.global.Diccionarios.DiccionarioGlobal.DiccionarioGlobal ( )

inline

Constructor.

Definición en la línea 30 del archivo DiccionarioGlobal.cs.

Documentación de funciones miembro

GetAllVariable()

DataTable sage.ew.global.Diccionarios.DiccionarioGlobal.GetAllVariable ( )

inline

PE-103101 Devuelve todas las variables de la GLOBAL cargadas en memoria.

Devuelve

Implementa sage.ew.interficies.Diccionario.IDiccionarioGlobal.

Definición en la línea 114 del archivo DiccionarioGlobal.cs.

Internal_GetValue()

override object sage.ew.global.Diccionarios.DiccionarioGlobal.Internal_GetValue ( string key, object defaultValue = null )

inlineprotected

A partir de un nombre de variable devuelve su valor en formato object y si no existe devuelve el default value.

Parámetros

key	Nombre de variable de configuración de empresa de la que se desea obtener su valor
defaultValue	Permite definir un valor por defecto en caso de que no se encuentre la variable

Devuelve

Definición en la línea 84 del archivo DiccionarioGlobal.cs.

Internal_SetValue()

override void sage.ew.global.Diccionarios.DiccionarioGlobal.Internal_SetValue ( string key, object value, bool lbSiExiste = true )

inlineprotected

Añade la clave y el valor especificado en el diccionario, en caso de que exista no lo modificará

Parámetros

key	Clave
value	Valor
lbSiExiste

Definición en la línea 62 del archivo DiccionarioGlobal.cs.

LoadData()

bool sage.ew.global.Diccionarios.DiccionarioGlobal.LoadData ( string empresa )

inline

Carga el diccionario de global.

Devuelve

Implementa sage.ew.interficies.Diccionario.IDiccionarioLoadByCompany.

Definición en la línea 142 del archivo DiccionarioGlobal.cs.

LoadExtra()

bool sage.ew.global.Diccionarios.DiccionarioGlobal.LoadExtra ( string rutaXml )

inline

/// PE-64379. Procedimiento que nos agrega al diccionario de variables globales las indicadas en el xml de la ruta "tcRutaXml" El documento xml debe tener un nodo para cada variable con el siguiente formato:

// <variables> //<nombre>wc_empresa</nombre> //<valor>01</valor> //<tipo>C</tipo> //</variables>

Parámetros

rutaXml

Devuelve

Implementa sage.ew.interficies.Diccionario.IDiccionarioGlobal.

Definición en la línea 163 del archivo DiccionarioGlobal.cs.

SetLoader()

void sage.ew.global.Diccionarios.DiccionarioGlobal.SetLoader ( IDiccionarioGlobalLoader diccionario )

inline

Inyecta el cargador del diccionario de vables globales.

Parámetros

diccionario

Implementa sage.ew.interficies.Diccionario.IDiccionarioGlobal.

Definición en la línea 40 del archivo DiccionarioGlobal.cs.

---

La documentación de esta clase está generada del siguiente archivo:

• C:/actions-runner/_work/Sage.ES.Sage50/Sage.ES.Sage50/src/Sage.ES.S50/sage.ew.global/Diccionarios/DiccionarioGlobal.cs