Clase base para el módulo comunidad50. Más...

Diagrama de herencia de sage.addons.comunidad50.comunidad50

Métodos públicos
override object	_Extension (string tcKey)
	Método para obtener la instancia de la clase de extensiones desde los documentos (PE-97109)

override Boolean	_Load ()
	Se ejecutará este método cuando se cargue el módulo.

override Boolean	_Unload ()
	Se ejecutará este método cuando se cierre eurowin.

override Boolean	_Update ()
	Se ejecutará este método cuando se actualize el módulo via FTP.

override String	_VFP_Open_Form (string tcForm, object[] toParams=null)
	Método que permite ejecutar un formulario en .VFP.

override String	_VFP_Open_Maintenance (string tcForm, string tcCode)
	Método que permite ejecutar un mantenimiento en .VFP.

override String	_VFP_Run_Function (string tcFunction, object[] toParams=null, bool tlArray=false)
	Método que permite ejecutar una función en .VFP.

override void	_SQLEXEC_Before (ref String tcSQL, ref Boolean tlOk)
	Método que permite modificar una instrucción SQL antes de ejecutarla.

override void	_SQLEXEC_After (ref DataTable tdtResult)
	Método que permite modificar el resultado de una instrucción SQL después de ejecutarla.

void	_SincronizarWebTask (bool tlShowMessage=false)
	Sincronizar con la Comunidad Sage 50 de forma asincrona (mediante Task)

bool	_SincronizarWeb (ref string lcMessage, ref System.Windows.Forms.MessageBoxIcon loIcon)
	Sincronizacion con la Comunidad Sage 50 de forma sincrona.

override bool	_Apertura (string tcEjerAnt, string tcEjerActual)
	Método para realizar apertura un addon.

Métodos públicos heredados de sage.ew.ewbase.Modulo
	Modulo ()
	Constructor vacío.

	Modulo (string tcAplica, string tcCodigo, string tcNombre, int tnFormuls, bool tlSuscripcion, bool tlVigente, DateTime? tdFechaIni, DateTime? tdFechaFin, string tcError, string tcProductoSagelic, bool tlEspecial, int tnUsuarios, List< string > toFormsControlUsuarios, string tcCodFormul, string tcVigencia)
	Constructor con datos.

	Modulo (string tcAplica, string tcCodigo, string tcNombre, int tnFormuls, bool tlSuscripcion, bool tlVigente, DateTime? tdFechaIni, DateTime? tdFechaFin, string tcError, string tcProductoSagelic, bool tlEspecial, int tnUsuarios, List< string > toFormsControlUsuarios, string tcCodFormul, string tcVigencia, bool tlCaracteristicaAdicional)
	Constructor con datos + característica adicional.

	Modulo (string tcAplica, string tcCodigo, string tcNombre, int tnFormuls, bool tlSuscripcion, bool tlVigente, DateTime? tdFechaIni, DateTime? tdFechaFin, string tcError, string tcProductoSagelic, bool tlEspecial, int tnUsuarios, List< string > toFormsControlUsuarios, string tcCodFormul, string tcVigencia, bool tlCaracteristicaAdicional, bool tlAddonSageLicensing)
	Constructor con datos + característica adicional + sagelicensing.

	Modulo (string tcAplica, string tcCodigo, string tcNombre, int tnFormuls, bool tlSuscripcion, bool tlVigente, DateTime? tdFechaIni, DateTime? tdFechaFin, string tcError, string tcProductoSagelic, bool tlEspecial, int tnUsuarios, List< string > toFormsControlUsuarios, string tcCodFormul, string tcVigencia, bool tlCaracteristicaAdicional, bool tlAddonSageLicensing, bool tlTryBuy)
	Constructor con datos + característica adicional + sagelicensing + trybuy.

	Modulo (string tcAplica, string tcCodigo, string tcNombre, int tnFormuls, bool tlSuscripcion, bool tlVigente, DateTime? tdFechaIni, DateTime? tdFechaFin, string tcError, string tcProductoSagelic, bool tlEspecial, int tnUsuarios, List< string > toFormsControlUsuarios, string tcCodFormul, string tcVigencia, bool tlCaracteristicaAdicional, bool tlAddonSageLicensing, bool tlTryBuy, DateTime? tdTryBuyFechaMin, DateTime? tdTryBuyFechaMax)
	Constructor con datos + característica adicional + sagelicensing + trybuy + trybuyfechas.

virtual void	_SalirAplicacion ()
	Para poder realizar algún tipo de acción al salir de la aplicación.

virtual bool	_Baja (string tcArticuloSage)
	Método para realizar acciones de baja en cada Addon.

virtual List< IOpcFlag >	_OpcFlags ()
	Para obtener las opciones especiales en cada Addon.

virtual IStockExtension	_ExtensionStock ()
	Cargar una extensión para la clase Stock.

virtual object	_Extension (string tcKey, IMante _mantePrincipal)
	Se utilizará para obtener un objeto con las extensiones de los módulos disponibles para el documento indicado mediante el parámetro tcKey (PE-97109)

virtual object	_ExtensionDocumentoBase (string tcKey, IDocumentoBase _documentobase)
	Se utilizará para obtener un objeto con las extensiones de los módulos disponibles para el documento base identificado mediante el parámetro tcKey.

virtual object	_ExtensionManteTRel (string tcKey)
	Se utilizará para obtener un objeto con las extensiones de los módulos disponibles para el documento indicado mediante el parámetro tcKey (PE-97109)

virtual object	_ExtensionManteTRel (string tcKey, IManteTRel _manteTRelPrincipal)
	Se utilizará para obtener un objeto con las extensiones de los módulos disponibles para el documento indicado mediante el parámetro tcKey (PE-97109)

virtual object	_ExtensionManteTRel (string tcKey, IManteTRel _manteTRelPrincipal, int _ordenAddon)
	Se utilizará para obtener un objeto con las extensiones de los módulos disponibles para el documento indicado mediante el parámetro tcKey (PE-97109)

virtual Tuple< bool, string >	_ValidateOpenForm (string tcNombreFormulario, TiposNavegacionPantalla tipoNavegacion)
	Establecer si un formulario concreto puede abrirse o no desde un add-on.

virtual void	_BindForm (string tcNombreForm, FormBase toForm)
	Vincula los formularios de la aplicación con los del addon.

virtual void	_BindForm (string tcNombreForm, IFormBase toForm)
	Vincula los formularios de la aplicación con los del addon.

virtual void	ConfigUserFormLoad (IFormBase toForm, Dictionary< string, object > toValoresDefecto)
	Vincula la carga de los valores por defecto de los formularios con los del addon.

virtual void	ConfigUserFormSave (IFormBase toForm, Dictionary< string, object > toValoresDefecto)
	Vincula el guardado de los valores por defecto de los formularios con los del addon.

virtual List< string >	ConfigUserOptionsDisabled (IFormBase toForm)
	Para poder indicar controles desactivados para el formulario actual desde Addons.

virtual IBrowserPropiedadesExtendidas	_BindBrowser (string browsertabla)
	Permite extender el browser.

virtual IBrowserColumnsExtender	_BrowserColumnsExtender (string browsertabla, string sql)
	Permite extender el browser.

virtual bool	_Unload (TipoExecute tcExecute)
	Se ejecutará este método cuando se cierre la aplicación.

virtual void	_SQLEXEC_Before (ref string tcSQL, ref Boolean tlOk)
	Método que permite modificar una instrucción SQL antes de ejecutarla.

virtual void	_CambioEmpresa (string tcEmpresaAnt, string tcEmpresaActual)
	PE-103556: Método que permite realizar acciones específicas del módulo si hay un cambio de empresa.

virtual void	_CambioEmpresa (TipoExecute tcExecute, string tcEmpresaAnt, string tcEmpresaActual)
	PE-103556: Método que permite realizar acciones específicas del módulo si hay un cambio de empresa.

virtual void	_CambioUsuario (string tcUsuarioAnt, string tcUsuarioActual)
	PE-103556: Método de cambio de usuario del Addon.

virtual void	_CambioUsuario (TipoExecute tcExecute, string tcUsuarioAnt, string tcUsuarioActual)
	Método de cambio de usuario del Addon.

virtual void	_CambioEjercicio (string tcEjerAnt, string tcEjerActual)
	PE-103556: Método de cambio de ejercicio del Addon.

virtual void	_CambioEjercicio (TipoExecute tcExecute, string tcEjerAnt, string tcEjerActual)
	Task 180057: Método de validaciones previas al cambio de ejercicio del Addon.

virtual void	_CambioGrupo (string tcGrupoAnt, string tcGrupoActual)
	Método de cambio de grupo del Addon.

virtual void	_CambioGrupo (TipoExecute tcExecute, string tcGrupoAnt, string tcGrupoActual)
	Método de validaciones previas/posteriores al cambio de grupo del Addon.

virtual bool	_Desinstalar (TipoExecute tcExecute)
	Task 122583 - Método para desinstalar un addon.

virtual bool	_Instalar (TipoExecute tcExecute)
	Task 122583 - Método para instalar un addon.

virtual bool	_CopiaSeguridad (int tnCopiaRestauracion, string tcRutaLocalCopia)
	Task 128265: Método para implementar por los addons si tienen algun tipo de carpeta extra a copiar e incluir en la copia de seguridad.

virtual bool	_AperturaValidar (eModoApertura toModoApertura, string tcEjerAnt, string tcEjerActual)
	Task 198379 : Método para validar el proceso de apertura antes de ejecutar.

virtual void	_ShowOnDesktopLoad (object toSender)
	Método que se invoca al finalizar la carga del escritorio por si el AddOn requiera operaciones en un tiempo que equivaldría al OnShown de un formulario.

virtual bool	_UpdateRelease ()
	Task 135557: Método que se ejecutará una vez que se haya actualizado las librerías.

string	_Exportar ()
	Método para exportar la configuración del módulo.

void	_Importar (string tcConfiguracion)
	Método para importar la configuración del módulo.

virtual void	_Asistente ()
	Permite mostrar un asistente después de la instalación del módulo. Se debe comprobar si el campo Asistente de la tabla config del módulo está a true para mostrar el asistente.

virtual void	_Menu (ToolStripMenuItem toMenu)
	Task 149997: Método para añadir una opción de Menú a un menú existente y poderlo hacer desde un módulo.

virtual object	_GetListaPrevia (string tcClass, Type oTipoObjeto, string tcPantalla)
	Devuelve la lista prévia del documento.

virtual List< IAperturaContador >	_AperturaContadores ()
	Para obtener los contadores en el proceso de nuevo ejercicio.

virtual void	_AperturaContadoresConfig (List< IAperturaContadorConfig > contadores)
	Para obtener/modificar los contadores del proceso de nuevo ejercicio.

virtual bool	_Contador (TipoExecute teTipoEjecucion, eTipoContadorDocumentos teTipoContador, eTipoOperacion teOperacion, string tcEmpresa, string tcSerie, ref string tcContador)
	Contador.

virtual IFiltrosOpcionesListados	_BindFormListado (String tcNombreListado)
	Permite añadir personalizaciones a los listados.

virtual IFiltrosOpcionesProcesos	_BindFormProceso (String tcNombreProceso)
	Permite añadir personalizaciones a los procesos.

virtual List< IButtonBarraHerram >	_BindFormBarraHerram (string tcPantalla)
	Obtiene una lista de IButtonBarraHerram para añadir los botones en la barra de los formularios.

virtual IAccesAddonUrl	_GetNewVersion ()
	Método para obtener los datos del addon y poder realizar una actualización del mismo.

virtual void	_BindBrowserPropiedadesExtendidas (IBrowserPropiedadesExtendidas browserpropiedadesextendidas)
	Permite capturar eventos definidos de la instancia IBrowserPropiedadesExtendidas.

virtual void	_BindListasPreviasDocumentos (IListasPreviasDocumento listasPreviasDocumento)
	Permite enlazar con las listas previas de documentos.

virtual void	_BindUpdateStocks (IUpdateStocks stocks)
	Permite enlazar con la clase Update_Stocks.

virtual IExtensionTiposModelo	_ExtensionTiposModelo (ITiposModelo tiposModelo)
	Extensiones de tipos de modelo.

virtual bool	_InstalarDesktop (int idDesktop, string nombreDesktop)
	Task 198805 Método para realizar acciones adicionales a la instalación de un escritorio.

virtual bool	_UpdateDesktop (int idDesktop, string nombreDesktop)
	Task 198805 Método para realizar acciones adicionales a la modificación de un escritorio.

virtual TipoAccionTarjetaAddon	_EstadoTarjetaAddon ()
	Devuelve el estado a presentar en la tareja del Add-on.

bool	_ExtractFile (string tcFileDll, string tcRutaFile, string tcFolderLib="", string tcNombreFile="", string tcRutaDestino="")
	Método para extraer los ficheros a partir de una DLL.

void	Log (TipoMensaje tipoMensaje, string descripcion, string sufijo="")
	Crear log dentro de la carpeta Logs\Sage50Addons.

virtual void	_CambioAutomatico (ref bool lbOk)
	Método para realizar cambios automáticos del Addon en el proceso iniciar la aplicación.

virtual void	_CambiarPropiedadesAddons (bool obOk)

virtual void	_BannerWarning ()

virtual void	_VisibilidadBanner ()

Propiedades
ComunidadSage50	_Configuracion `[get]`
	Configuración del módulo de fideliza.

Propiedades heredados de sage.ew.ewbase.Modulo
ProcesosEnEjecucion	_TipoProceso `[get, set]`
	En el momento de cargar extensiones, cada Addon deberá decicir en función del valor que haya en esta propiedad si cargar las extensiones o no.

string	_AliasDB `[get, set]`
	Alias de la Base de datos.

string	_Version `[get, set]`
	Versión del módulo.

string	_UrlFTP `[get, set]`
	Ruta FTP de actualñización del módulo.

List< string >	_IncompatibleModules `[get, set]`
	Lista de módulos incompatibles.

string	_Nombre `[get, set]`
	Nombre interno del módulo y nombre del directorio de instación.

string	_Nombre2 `[get, set]`
	Nombre visible del módulo.

string	_NombreConexion `[get, set]`
	Nombre real de la base de datos.

int	_Tipo `[get, set]`
	Tipo de addon.

string	_Libreria `[get, set]`
	Nombre del ensamblado del módulo.

virtual String	_LibreriaModulo `[get, set]`
	Nombre del ensamblado del módulo.

string	_Clase `[get, set]`
	Nombre de la clase principal del módulo (this)

string	_Error_Message `[get, set]`
	Contiene el último texto de error generado.

Assembly	_Assembly `[get, set]`
	Contendra el Assembly del addon.

virtual string	Firma `[get, set]`
	Firma del addon.

virtual bool	_Obligatorio `[get]`
	Obtiene o establece la obligatoriedad del módulo en la instalación.

string	_UrlAyudaAddon = "" `[get, set]`
	Ruta FTP de ayuda del addon.

ConnectedController	_ConnectedController `[get]`
	ConnectedController.

bool	_TryBuy `[get]`
	Nos informa si el add-on está instalado en modo de Try'n'Buy.

DateTime?	_TryBuyFechaMin `[get]`
	Fecha inicio del try'n'buy.

DateTime?	_TryBuyFechaMax `[get]`
	Fecha final del try'n'buy.

int	_TryBuyDiasRestantes `[get]`
	Devuelve el número de días que nos quedan de try'n'buy.

DateTime?	_BajaFecha `[get]`
	Fecha de baja del Addon.

string	_NombreMenu `[get]`
	Nombre para el menú del add-on.

string	_NombrePagina `[get]`
	Nombre para las páginas asociadas en los mantenimientos Si tenemos nombre página lo devolvemos, en otro caso, devolvemos nombre2.

string	_Aplica `[get]`
	Campo APLICA de ACCESOLIC.

string	_Codigo `[get]`
	Campo MODULO de ACCESOLIC (Código del módulo a Eurowin)

string	_ProductoSagelic `[get]`
	Código del producto a Sagelic (100885)

int	_Formuls `[get]`
	Campo FORMULS de ACCESOLIC (Número de formularios en la tabla FORMULS del módulo)

bool	_Suscripcion `[get]`
	Modo Suscripción (True / False)

bool	_Vigente `[get]`
	Suscripción vigente (True / False)

string	_VigenciaAddon `[get]`
	Para controlar la vigencia en addons incluidos en la licencia principal y de PAM en ACCESOLIC. Task 143532.

string	_CodFormul `[get]`
	Para control de la tabla FORMULS en ACCESOLIC. Task 143532.

bool	_Especial `[get]`
	Modulo especial, depende del producto principal (True / False) (PE-101206)

bool	_CaracteristicaAdicional `[get]`
	Característica adicional incluida en el fichero Sagelic. No se trata de un addon. Por ejemplo artículos del SII (ASF50SIICANAR,...)

bool	_AddonSageLicensing `[get]`
	Para identificar los addons que el cliente tiene definidos en SageLicense (sagelic)

DateTime?	_FechaInicio `[get]`
	Fecha inicio suscripción.

DateTime?	_FechaFin `[get]`
	Fecha final suscripción.

string	_Error `[get]`
	Error.

int	_Usuarios `[get]`
	Nº de usuarios (PE-103236)

List< Modulo >	_AddonsRelacionados `[get, set]`
	Lista con los posibles Addons relacionados con el Addon principal Ej: FACTUCERT(TBAI y VERIFACTU)

List< string >	_FormsControlUsuarios `[get]`
	Lista de los formularios del módulo dónde hay que controlar el nº de usuarios (PE-103236)

Otros miembros heredados
Campos de datos heredados de sage.ew.ewbase.Modulo
Type	UserControlConfigType
	Referencia a la parte visual de la configuración del addon.

Type	ModuloConfigType
	Referencia a la parte visual de la configuración del addon.

bool	_VisibleConfiguracionEmpresa = true
	Nos indicará si se mostrará la configuración de empresa para este módulo.

Métodos protegidos heredados de sage.ew.ewbase.Modulo
virtual void	OnTipoProcesoChanged ()
	Método para que las clases derivadas puedan ajustar su funcionamiento al tipo de proceso.

Atributos protegidos heredados de sage.ew.ewbase.Modulo
DateTime?	_dBajaFecha
	Fecha de baja del Addon.

string	_cNombreMenu = string.Empty
	Nombre para el menú del add-on.

string	_cNombrePagina = string.Empty
	Nombre para las páginas asociadas en los mantenimientos.

Descripción detallada

Clase base para el módulo comunidad50.

Definición en la línea 46 del archivo SageAddons.cs.

Documentación de funciones miembro

◆ _Apertura()

override bool sage.addons.comunidad50.comunidad50._Apertura	(	string	tcEjerAnt,
		string	tcEjerActual )

inlinevirtual

Método para realizar apertura un addon.

Parámetros

tcEjerAnt
tcEjerActual

Devuelve: true si ha sido correcto

Reimplementado de sage.ew.ewbase.Modulo.

Definición en la línea 271 del archivo SageAddons.cs.

◆ _Extension()

override object sage.addons.comunidad50.comunidad50._Extension ( string tcKey )

inlinevirtual

Método para obtener la instancia de la clase de extensiones desde los documentos (PE-97109)

Parámetros

tcKey

Devuelve

Reimplementado de sage.ew.ewbase.Modulo.

Definición en la línea 86 del archivo SageAddons.cs.

◆ _Load()

override Boolean sage.addons.comunidad50.comunidad50._Load ( )

inlinevirtual

Se ejecutará este método cuando se cargue el módulo.

Devuelve: true si la carga del módulo finaliza con éxito, false en caso contrario

Reimplementado de sage.ew.ewbase.Modulo.

Definición en la línea 107 del archivo SageAddons.cs.

◆ _SincronizarWeb()

bool sage.addons.comunidad50.comunidad50._SincronizarWeb	(	ref string	lcMessage,
		ref System.Windows.Forms.MessageBoxIcon	loIcon )

inline

Sincronizacion con la Comunidad Sage 50 de forma sincrona.

Devuelve

Definición en la línea 222 del archivo SageAddons.cs.

◆ _SincronizarWebTask()

void sage.addons.comunidad50.comunidad50._SincronizarWebTask ( bool tlShowMessage = false )

inline

Sincronizar con la Comunidad Sage 50 de forma asincrona (mediante Task)

Definición en la línea 193 del archivo SageAddons.cs.

◆ _SQLEXEC_After()

override void sage.addons.comunidad50.comunidad50._SQLEXEC_After ( ref DataTable tdtResult )

inlinevirtual

Método que permite modificar el resultado de una instrucción SQL después de ejecutarla.

Parámetros

tdtResult Datatable con los resultados de la consulta

Reimplementado de sage.ew.ewbase.Modulo.

Definición en la línea 185 del archivo SageAddons.cs.

◆ _SQLEXEC_Before()

override void sage.addons.comunidad50.comunidad50._SQLEXEC_Before	(	ref String	tcSQL,
		ref Boolean	tlOk )

inline

Método que permite modificar una instrucción SQL antes de ejecutarla.

Parámetros

tcSQL	String con la consulta a ejecutar
tlOk	Campo logico que indica si se puede continuar con la ejecución de la consulta

Definición en la línea 175 del archivo SageAddons.cs.

◆ _Unload()

override Boolean sage.addons.comunidad50.comunidad50._Unload ( )

inlinevirtual

Se ejecutará este método cuando se cierre eurowin.

Devuelve: true si la descarga del módulo finaliza con éxito, false en caso contrario

Reimplementado de sage.ew.ewbase.Modulo.

Definición en la línea 122 del archivo SageAddons.cs.

◆ _Update()

override Boolean sage.addons.comunidad50.comunidad50._Update ( )

inlinevirtual

Se ejecutará este método cuando se actualize el módulo via FTP.

Devuelve: true si se actualiza el módulo con éxito, false en caso contrario

Reimplementado de sage.ew.ewbase.Modulo.

Definición en la línea 131 del archivo SageAddons.cs.

◆ _VFP_Open_Form()

override String sage.addons.comunidad50.comunidad50._VFP_Open_Form	(	string	tcForm,
		object[]	toParams = null )

inlinevirtual

Método que permite ejecutar un formulario en .VFP.

Parámetros

tcForm	Formulario que se quiere abrir
toParams	Parámetros que se pasarán a la llamada

Devuelve: Retorna el valor de NETVFP._Parametros["valor"]

Reimplementado de sage.ew.ewbase.Modulo.

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

◆ _VFP_Open_Maintenance()

override String sage.addons.comunidad50.comunidad50._VFP_Open_Maintenance	(	string	tcForm,
		string	tcCode )

inlinevirtual

Método que permite ejecutar un mantenimiento en .VFP.

Parámetros

tcForm	Mantenimiento que se quiere abrir
tcCode	Código del registro que se quiere cargar

Devuelve: Retorna el valor de NETVFP._Parametros["valor"]

Reimplementado de sage.ew.ewbase.Modulo.

Definición en la línea 153 del archivo SageAddons.cs.

◆ _VFP_Run_Function()

override String sage.addons.comunidad50.comunidad50._VFP_Run_Function	(	string	tcFunction,
		object[]	toParams = null,
		bool	tlArray = false )

inlinevirtual

Método que permite ejecutar una función en .VFP.

Parámetros

tcFunction	Función que se quiere llamar
toParams	Parámetros que se pasarán a la llamada
tlArray	Indica si debe generar un fichero XML para recuperar los parámetros

Devuelve: Retorna el valor de NETVFP._Parametros["valor"]

Reimplementado de sage.ew.ewbase.Modulo.

Definición en la línea 165 del archivo SageAddons.cs.

Documentación de propiedades

◆ _Configuracion

ComunidadSage50 sage.addons.comunidad50.comunidad50._Configuracion

get

Configuración del módulo de fideliza.

Definición en la línea 55 del archivo SageAddons.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/addons/comunidad50/comunidad50/SageAddons.cs

Métodos públicos

Propiedades

Otros miembros heredados

Descripción detallada

Documentación de funciones miembro

◆ _Apertura()

◆ _Extension()

◆ _Load()

◆ _SincronizarWeb()

◆ _SincronizarWebTask()

◆ _SQLEXEC_After()

◆ _SQLEXEC_Before()

◆ _Unload()

◆ _Update()

◆ _VFP_Open_Form()

◆ _VFP_Open_Maintenance()

◆ _VFP_Run_Function()

Documentación de propiedades

◆ _Configuracion