Class StdBSMapas2008

Serviços de impressão e configuração de mapas.

Inheritance
System.Object
StdBSMapas2008
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: StdPlatBS100
Assembly: StdPlatBS100.dll
Syntax
[ComVisible(true)]
[Guid("9BA63D27-DD3D-4851-A2D6-2B6351EB3572")]
[ClassInterface(ClassInterfaceType.None)]
public class StdBSMapas2008 : IStdBSMapas2008

Properties

AbvtApl

Gets the abvt apl.

Declaration
public string AbvtApl { get; }
Property Value
Type Description
System.String

ActiveBar

Devolve a ActiveBar presente na janela de pré-visualização.

Declaration
public dynamic ActiveBar { get; }
Property Value
Type Description
System.Object

ConfiguracoesCheque

Define as configurações de impressão de um cheque.

Declaration
public StdBSTipos.TCheque ConfiguracoesCheque { set; }
Property Value
Type Description
StdBSTipos.TCheque

Destino

Destino de exportação.

Declaration
public StdBSTipos.CRPEExportDestino Destino { get; set; }
Property Value
Type Description
StdPlatBS100.StdBSTipos.CRPEExportDestino

GroupSelectionFormula

Group selection formula.

Declaration
public string GroupSelectionFormula { get; set; }
Property Value
Type Description
System.String

Impressora

Definição da impressora a utilizar. [Deprecated/Obsulete - utilizar ImpressoraEx]

Declaration
public StdBSTipos.TPrinter Impressora { get; set; }
Property Value
Type Description
StdBSTipos.TPrinter

ImpressoraEx

Definição da impressora a utilizar.

Declaration
public StdBSTipos.TPrinterEx ImpressoraEx { get; set; }
Property Value
Type Description
StdBSTipos.TPrinterEx

ImpressoraEx2

Definição da impressora a utilizar.

Declaration
public StdBSTipos.TPrinterEx2 ImpressoraEx2 { get; set; }
Property Value
Type Description
StdBSTipos.TPrinterEx2

JanelaPrincipal

Janela principal de pré-visualização de mapas.

Declaration
public int JanelaPrincipal { get; set; }
Property Value
Type Description
System.Int32

MostraErros

Permite definir se as impressões devem ou não mostrar mensagens de erro.

Declaration
public bool MostraErros { set; }
Property Value
Type Description
System.Boolean

NumeroParametros

Número de parâmetros definidos num mapa.

Declaration
public int NumeroParametros { get; }
Property Value
Type Description
System.Int32

PermiteRefresh

Define se a pré-visualização dos mapas permite o refrescamento da view.

Declaration
public bool PermiteRefresh { set; }
Property Value
Type Description
System.Boolean

PrintSessionId

Devolve o identificador da última impressão

Declaration
public string PrintSessionId { get; }
Property Value
Type Description
System.String
Remarks

Este método deve ser invocado depois do método Inicializar.

QuerySQL

Query SQL a utilizar para obter os registos a imprimir.

Declaration
public string QuerySQL { get; set; }
Property Value
Type Description
System.String

SelectionFormula

Selection formula.

Declaration
public string SelectionFormula { get; set; }
Property Value
Type Description
System.String

ThrowError

Declaration
public bool ThrowError { set; }
Property Value
Type Description
System.Boolean

TipoFolha

Definição do tipo de folha.

Declaration
public StdBSTipos.CRPETipoFolha TipoFolha { get; set; }
Property Value
Type Description
StdPlatBS100.StdBSTipos.CRPETipoFolha

VerificarBdAntesImpressao

Validação da estrutura da base de dados antes de uma impressão

Declaration
public bool VerificarBdAntesImpressao { set; }
Property Value
Type Description
System.Boolean

Methods

AddBoolGroupCondition(StdBSTipos.CRPESections, String, StdBSTipos.CRPEBoolTrigger, StdBSTipos.CRPESentidoOrdenacao)

Declaration
public void AddBoolGroupCondition(StdBSTipos.CRPESections rCodSeccao, string sCampoBool, StdBSTipos.CRPEBoolTrigger eCondicao, StdBSTipos.CRPESentidoOrdenacao eSentido)
Parameters
Type Name Description
StdPlatBS100.StdBSTipos.CRPESections rCodSeccao
System.String sCampoBool
StdPlatBS100.StdBSTipos.CRPEBoolTrigger eCondicao
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentido

AddDateGroupCondition(StdBSTipos.CRPESections, String, StdBSTipos.CRPEDateTrigger, StdBSTipos.CRPESentidoOrdenacao)

Declaration
public void AddDateGroupCondition(StdBSTipos.CRPESections rCodSeccao, string sCampoData, StdBSTipos.CRPEDateTrigger eCondicao, StdBSTipos.CRPESentidoOrdenacao eSentido)
Parameters
Type Name Description
StdPlatBS100.StdBSTipos.CRPESections rCodSeccao
System.String sCampoData
StdPlatBS100.StdBSTipos.CRPEDateTrigger eCondicao
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentido

AddFormula(String, String, Boolean)

Adiciona uma fórmula ao mapa.

Declaration
public void AddFormula(string sNomeFormula, string sFormula, bool bTrataPlicas = true)
Parameters
Type Name Description
System.String sNomeFormula

Nome da fórmula.
System.String sFormula

Valor da fórmula.
System.Boolean bTrataPlicas

Tratamento das pelicas no valor da fórmula.

AddFormulaSubReport(String, String, String, Boolean)

Adiciona uma fórmula ao mapa.

Declaration
public void AddFormulaSubReport(string sSubReport, string sNomeFormula, string sFormula, bool bTrataPlicas = true)
Parameters
Type Name Description
System.String sSubReport

Nome do subreport.
System.String sNomeFormula

Nome da fórmula.
System.String sFormula

Valor da fórmula.
System.Boolean bTrataPlicas

Tratamento das pelicas no valor da fórmula.

AddGroupCondition(StdBSTipos.CRPESections, String, StdBSTipos.CRPESentidoOrdenacao)

Adiciona uma condição de grupo.

Declaration
public void AddGroupCondition(StdBSTipos.CRPESections rCodSeccao, string sCampo, StdBSTipos.CRPESentidoOrdenacao eSentido)
Parameters
Type Name Description
StdPlatBS100.StdBSTipos.CRPESections rCodSeccao

Secção.
System.String sCampo

Campo.
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentido

Sentido.

AddOrdemGrupo(String, Int32, StdBSTipos.CRPESentidoOrdenacao)

Adiciona uma ordenação.

Declaration
public void AddOrdemGrupo(string sGroupOrden, int iOrdem, StdBSTipos.CRPESentidoOrdenacao eSentido)
Parameters
Type Name Description
System.String sGroupOrden

Grupo de ordenação.
System.Int32 iOrdem

Ordem.
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentido

Sentido.

AddParametro(String, Object)

Adiciona um

Valor. Nome do parâmetro. parâmetro ao mapa.
Declaration
public void AddParametro(string sNomeParametro, dynamic vValor)
Parameters
Type Name Description
System.String sNomeParametro
System.Object vValor

AddSectionFormat(StdBSTipos.CRPESections, StdBSTipos.CRPEFlagSection, StdBSTipos.CRPEFlagSection, StdBSTipos.CRPEFlagSection, StdBSTipos.CRPEFlagSection, StdBSTipos.CRPEFlagSection, StdBSTipos.CRPEFlagSection, StdBSTipos.CRPEFlagSection, StdBSTipos.CRPEFlagSection, StdBSTipos.CRPEFlagSection, StdBSTipos.CRPEFlagSection)

Adiciona uma formatação de secção.

Declaration
public void AddSectionFormat(StdBSTipos.CRPESections rCodigoSeccao, StdBSTipos.CRPEFlagSection bVisivel = StdBSTipos.CRPEFlagSection.fsMantem, StdBSTipos.CRPEFlagSection bNovaPagAntes = StdBSTipos.CRPEFlagSection.fsMantem, StdBSTipos.CRPEFlagSection bNovaPagDepois = StdBSTipos.CRPEFlagSection.fsMantem, StdBSTipos.CRPEFlagSection bKeepTogether = StdBSTipos.CRPEFlagSection.fsMantem, StdBSTipos.CRPEFlagSection bSuprimeEspacoVazio = StdBSTipos.CRPEFlagSection.fsMantem, StdBSTipos.CRPEFlagSection bResetNumPagDepois = StdBSTipos.CRPEFlagSection.fsMantem, StdBSTipos.CRPEFlagSection bImprimeNoFundoPag = StdBSTipos.CRPEFlagSection.fsMantem, StdBSTipos.CRPEFlagSection bUnderLaySection = StdBSTipos.CRPEFlagSection.fsMantem, StdBSTipos.CRPEFlagSection bShowArea = StdBSTipos.CRPEFlagSection.fsMantem, StdBSTipos.CRPEFlagSection bFreeFormPlacement = StdBSTipos.CRPEFlagSection.fsMantem)
Parameters
Type Name Description
StdPlatBS100.StdBSTipos.CRPESections rCodigoSeccao

Secção.
StdPlatBS100.StdBSTipos.CRPEFlagSection bVisivel

Visível?
StdPlatBS100.StdBSTipos.CRPEFlagSection bNovaPagAntes

Nova página antes.
StdPlatBS100.StdBSTipos.CRPEFlagSection bNovaPagDepois

Nova página depois.
StdPlatBS100.StdBSTipos.CRPEFlagSection bKeepTogether

Manter juntas (keep together).
StdPlatBS100.StdBSTipos.CRPEFlagSection bSuprimeEspacoVazio

Suprimir espaço vazio.
StdPlatBS100.StdBSTipos.CRPEFlagSection bResetNumPagDepois

Reiniciar numeração de páginas depois.
StdPlatBS100.StdBSTipos.CRPEFlagSection bImprimeNoFundoPag

Imprimir no fundo da página.
StdPlatBS100.StdBSTipos.CRPEFlagSection bUnderLaySection

"Underlay section".
StdPlatBS100.StdBSTipos.CRPEFlagSection bShowArea

"Show area".
StdPlatBS100.StdBSTipos.CRPEFlagSection bFreeFormPlacement

"Free form placement".

AddTable(String, String)

Adiciona uma nova tabela ao mapa.

Declaration
public void AddTable(string strTabela, string strAlias)
Parameters
Type Name Description
System.String strTabela

Nome da tabela.
System.String strAlias

Alias da tabela.

AddTableLink(String, String, String[], String[], crLinkJoinType)

Adiciona uma nova ligação entre tabelas do mapa.

Declaration
public void AddTableLink(string sTabelaOrigem, string sTabelaDestino, string[] sCamposOrigem, string[] sCamposDestino, crLinkJoinType eTipoJoin)
Parameters
Type Name Description
System.String sTabelaOrigem
System.String sTabelaDestino
System.String[] sCamposOrigem
System.String[] sCamposDestino
crLinkJoinType eTipoJoin

CarregaTabelasCategoria(String, Boolean)

Carrega as tabelas associadas a uma categoria para o mapa.

Declaration
public void CarregaTabelasCategoria(string strCategoria, bool blnUsaSufixoCategoria = false)
Parameters
Type Name Description
System.String strCategoria

Nome da categoria.
System.Boolean blnUsaSufixoCategoria

Indica se deve ser usado um sufixo para o Alias da tabela. O sufixo é construído da seguinte forma: "_<strCategoria>".

CarregaTabelasDaCategoria(String, String[], Boolean)

Carrega um conjunto de tabelas associadas a uma categoria para o mapa.

Declaration
public void CarregaTabelasDaCategoria(string strCategoria, string[] strTabelas, bool blnUsaSufixoCategoria = false)
Parameters
Type Name Description
System.String strCategoria

Nome da categoria.
System.String[] strTabelas

Tabelas a carregar.
System.Boolean blnUsaSufixoCategoria

Indica se deve ser usado um sufixo para o Alias da tabela. O sufixo é construído da seguinte forma: "_<strCategoria>".

ClosePrintSession(String)

Termina uma sessão de impressão.

Declaration
public void ClosePrintSession(string strSessionId)
Parameters
Type Name Description
System.String strSessionId

Id da sessão de impressão

DaParametrosReport(String)

Devolve uma lista dos parâmetros definidos no mapa.

Declaration
public bool DaParametrosReport(string strNomeReport)
Parameters
Type Name Description
System.String strNomeReport

Nome do mapa.
Returns
Type Description
System.Boolean
Remarks

A definição dos parâmetros pode ser obtido usando os métodos ParametroNNome, ParametroNTipoValor e ParametroNValorPorDefeito.

DefinicaoImpressora(String, String, String, String, StdBSTipos.CRPEOrientacaoFolha, Int32, StdBSTipos.CRPETipoFolha, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Definição das características da impressora a utilizar.

Declaration
public void DefinicaoImpressora(string sNome, string sDriver, string sDevice, string sPorta, StdBSTipos.CRPEOrientacaoFolha eOrientacaoFolha, int lQualidade, StdBSTipos.CRPETipoFolha eTipoFolha, int iFolhaAltura, int iFolhaComp, int iNrCopias, int iDuplex, int iDaPagina, int iAtePagina, int iBandeja)
Parameters
Type Name Description
System.String sNome

Nome da impressora.
System.String sDriver

Driver.
System.String sDevice

Device.
System.String sPorta

Porta.
StdPlatBS100.StdBSTipos.CRPEOrientacaoFolha eOrientacaoFolha

Orientação da folha.
System.Int32 lQualidade

Qualidade de impressão.
StdPlatBS100.StdBSTipos.CRPETipoFolha eTipoFolha

Tipo de folha.
System.Int32 iFolhaAltura

Altura da folha.
System.Int32 iFolhaComp

Comprimento da folha.
System.Int32 iNrCopias

Número de cópias.
System.Int32 iDuplex

Impressão duplex.
System.Int32 iDaPagina

Imprimir da página X.
System.Int32 iAtePagina

Imprimir até à página Y.
System.Int32 iBandeja

DefinicaoImpressoraEx(String, String, String, String, StdBSTipos.CRPEOrientacaoFolha, Int32, StdBSTipos.CRPETipoFolha, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Definição das características da impressora a utilizar.

Declaration
public void DefinicaoImpressoraEx(string sNome, string sDriver, string sDevice, string sPorta, StdBSTipos.CRPEOrientacaoFolha eOrientacaoFolha, int lQualidade, StdBSTipos.CRPETipoFolha eTipoFolha, int lFolhaAltura, int lFolhaComp, int iNrCopias, int iDuplex, int iDaPagina, int iAtePagina, int iBandeja)
Parameters
Type Name Description
System.String sNome

Nome da impressora.
System.String sDriver

Driver.
System.String sDevice

Device.
System.String sPorta

Porta.
StdPlatBS100.StdBSTipos.CRPEOrientacaoFolha eOrientacaoFolha

Orientação da folha.
System.Int32 lQualidade

Qualidade de impressão.
StdPlatBS100.StdBSTipos.CRPETipoFolha eTipoFolha

Tipo de folha.
System.Int32 lFolhaAltura

Altura da folha.
System.Int32 lFolhaComp

Comprimento da folha.
System.Int32 iNrCopias

Número de cópias.
System.Int32 iDuplex

Impressão duplex.
System.Int32 iDaPagina

Imprimir da página X.
System.Int32 iAtePagina

Imprimir até à página Y.
System.Int32 iBandeja

DefinicaoImpressoraIntegracao(String, String, String, String, StdBSTipos.CRPEOrientacaoFolha, Int32, StdBSTipos.CRPETipoFolha, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Definição das características da impressora a utilizar em integração.

Declaration
public void DefinicaoImpressoraIntegracao(string sNome, string sDriver, string sDevice, string sPorta, StdBSTipos.CRPEOrientacaoFolha eOrientacaoFolha, int lQualidade, StdBSTipos.CRPETipoFolha eTipoFolha, int lFolhaAltura, int lFolhaComp, int iNrCopias, int iDuplex, int iDaPagina, int iAtePagina, int iBandeja)
Parameters
Type Name Description
System.String sNome

Nome da impressora.
System.String sDriver

Driver.
System.String sDevice

Device.
System.String sPorta

Porta.
StdPlatBS100.StdBSTipos.CRPEOrientacaoFolha eOrientacaoFolha

Orientação da folha.
System.Int32 lQualidade

Qualidade de impressão.
StdPlatBS100.StdBSTipos.CRPETipoFolha eTipoFolha

Tipo de folha.
System.Int32 lFolhaAltura

Altura da folha.
System.Int32 lFolhaComp

Comprimento da folha.
System.Int32 iNrCopias

Número de cópias.
System.Int32 iDuplex

Impressão duplex.
System.Int32 iDaPagina

Imprimir da página X.
System.Int32 iAtePagina

Imprimir até à página Y.
System.Int32 iBandeja

Número da bandeja da impressora.

DelOrdemGrupo(Int32)

Remover uma ordenação de grupo.

Declaration
public void DelOrdemGrupo(int iNumCampoOrd)
Parameters
Type Name Description
System.Int32 iNumCampoOrd

Número do campo de ordenação.

DelOrdenacao(Int32)

Remover uma ordenação.

Declaration
public void DelOrdenacao(int iNumCampoOrd)
Parameters
Type Name Description
System.Int32 iNumCampoOrd

Número do campo de ordenação.

DuplicatePdfSideBySide(ref Byte[], ref Byte[])

Termina uma sessão de impressão.

Declaration
public void DuplicatePdfSideBySide(ref byte[] sourceStream, ref byte[] destinationStream)
Parameters
Type Name Description
System.Byte[] sourceStream

documento origem
System.Byte[] destinationStream

documento destino

ExportPrintSessionToFile(String, ref String, StdBSTipos.CRPEExportDestino)

Termina uma sessão de impressão.

Declaration
public void ExportPrintSessionToFile(string strPrintSessionId, ref string strFileName, StdBSTipos.CRPEExportDestino enuExportDestino)
Parameters
Type Name Description
System.String strPrintSessionId

Id da sessão de impressão
System.String strFileName

Nome do ficheiro.
StdPlatBS100.StdBSTipos.CRPEExportDestino enuExportDestino

Formato de exportação.

ExportPrintSessionToMemory(String, ref Byte[])

Termina uma sessão de impressão.

Declaration
public void ExportPrintSessionToMemory(string strPrintSessionId, ref byte[] arrByte)
Parameters
Type Name Description
System.String strPrintSessionId
System.Byte[] arrByte

ExportPrintSessionToStream(String)

Exporta a sessão para uma System.IO.Stream

Declaration
public Stream ExportPrintSessionToStream(string sessionId)
Parameters
Type Name Description
System.String sessionId

Identificador da sessão
Returns
Type Description
System.IO.Stream

Finalize()

StdBSMapas2008 class destructor.

Declaration
protected void Finalize()

GetActiveBarEx(String)

Devolve a ActiveBar presente na janela de pré-visualização.

Declaration
public dynamic GetActiveBarEx(string strPrintSessionId)
Parameters
Type Name Description
System.String strPrintSessionId
Returns
Type Description
System.Object

GetCategInfo(String, String)

Devolve informação sobre uma categoria de mapas.

Declaration
public StdBSTipos.TCategMapa GetCategInfo(string strApl, string strCategoria)
Parameters
Type Name Description
System.String strApl
System.String strCategoria

Nome da categoria.
Returns
Type Description
StdBSTipos.TCategMapa

GetMapaInfo(String, String)

Devolve informação sobre um mapa.

Declaration
public StdBSTipos.TMapa GetMapaInfo(string strApl, string strMapa)
Parameters
Type Name Description
System.String strApl
System.String strMapa

Nome do mapa.
Returns
Type Description
StdBSTipos.TMapa

GetMapaInfoEx(String, String, String)

Devolve informação sobre um mapa (especificado pela categoria e pelo nome do mapa).

Declaration
public StdBSTipos.TMapa GetMapaInfoEx(string strApl, string strCategoria, string strMapa)
Parameters
Type Name Description
System.String strApl
System.String strCategoria

Categoria mapa.
System.String strMapa

Nome do mapa.
Returns
Type Description
StdBSTipos.TMapa

GetParametroNIsMainReport(Int32)

Devolve se o parametro é parametro do main report

Declaration
public int GetParametroNIsMainReport(int Parametro)
Parameters
Type Name Description
System.Int32 Parametro

Posição do parâmetro na lista de parâmetros.
Returns
Type Description
System.Int32

GetParametroNNome(Int32)

Devolve o nome do parâmetro definido na posição "Parametro".

Declaration
public string GetParametroNNome(int Parametro)
Parameters
Type Name Description
System.Int32 Parametro

Posição do parâmetro na lista de parâmetros.
Returns
Type Description
System.String

GetParametroNTipoListaValores(Int32)

Devolve o tipo da lista de valores do parâmetro definido na posição "Parametro" (0 - Static | 1 - Dynamic).

Declaration
public int GetParametroNTipoListaValores(int Parametro)
Parameters
Type Name Description
System.Int32 Parametro

Posição do parâmetro na lista de parâmetros.
Returns
Type Description
System.Int32

GetParametroNTipoValor(Int32)

Devolve o tipo de valor do parâmetro definido na posição "Parametro".

Declaration
public int GetParametroNTipoValor(int Parametro)
Parameters
Type Name Description
System.Int32 Parametro

Posição do parâmetro na lista de parâmetros.
Returns
Type Description
System.Int32

GetParametroNValorPorDefeito(Int32)

Valor por defeito do parâmetro definido na posição "Parametro".

Declaration
public string GetParametroNValorPorDefeito(int Parametro)
Parameters
Type Name Description
System.Int32 Parametro

Posição do parâmetro na lista de parâmetros.
Returns
Type Description
System.String

ImprimeListagem()

Declaration
public int ImprimeListagem()
Returns
Type Description
System.Int32

ImprimeListagem(String)

Declaration
public int ImprimeListagem(string sReport)
Parameters
Type Name Description
System.String sReport
Returns
Type Description
System.Int32

ImprimeListagem(String, String)

Declaration
public int ImprimeListagem(string sReport, string sTitulo)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String, String)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, string sSelFormula)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String, String, StdBSTipos.CRPESentidoOrdenacao)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String, String, StdBSTipos.CRPESentidoOrdenacao, Boolean)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bCategoria)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
System.Boolean bCategoria
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String, String, StdBSTipos.CRPESentidoOrdenacao, Boolean, Boolean)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bCategoria, bool bMapaSistema)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
System.Boolean bCategoria
System.Boolean bMapaSistema
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String, String, StdBSTipos.CRPESentidoOrdenacao, Boolean, Boolean, String)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bCategoria, bool bMapaSistema, string sQuerySQL)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
System.Boolean bCategoria
System.Boolean bMapaSistema
System.String sQuerySQL
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String, String, StdBSTipos.CRPESentidoOrdenacao, Boolean, Boolean, String, Boolean)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bCategoria, bool bMapaSistema, string sQuerySQL, bool blnModal)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
System.Boolean bCategoria
System.Boolean bMapaSistema
System.String sQuerySQL
System.Boolean blnModal
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String, String, StdBSTipos.CRPESentidoOrdenacao, Boolean, Boolean, String, Boolean, StdBETipos.EnumGlobalCultures)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bCategoria, bool bMapaSistema, string sQuerySQL, bool blnModal, StdBETipos.EnumGlobalCultures eCultura)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
System.Boolean bCategoria
System.Boolean bMapaSistema
System.String sQuerySQL
System.Boolean blnModal
StdBETipos.EnumGlobalCultures eCultura
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String, String, StdBSTipos.CRPESentidoOrdenacao, Boolean, Boolean, String, Boolean, StdBETipos.EnumGlobalCultures, Boolean)

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bCategoria, bool bMapaSistema, string sQuerySQL, bool blnModal, StdBETipos.EnumGlobalCultures eCultura, bool blnImpressaoCheque)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
System.Boolean bCategoria
System.Boolean bMapaSistema
System.String sQuerySQL
System.Boolean blnModal
StdBETipos.EnumGlobalCultures eCultura
System.Boolean blnImpressaoCheque
Returns
Type Description
System.Int32

ImprimeListagem(String, String, String, Int32, String, String, StdBSTipos.CRPESentidoOrdenacao, Boolean, Boolean, String, Boolean, StdBETipos.EnumGlobalCultures, Boolean, String)

Impressão de um mapa.

Declaration
public int ImprimeListagem(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bCategoria, bool bMapaSistema, string sQuerySQL, bool blnModal, StdBETipos.EnumGlobalCultures eCultura, bool blnImpressaoCheque, string strUniqueIdentifier)
Parameters
Type Name Description
System.String sReport

Nome do mapa.
System.String sTitulo

Título do mapa.
System.String sDestino

Destino: "W" - Window; "P" - Printer, "S" - Guarda a janela de impressão em memória e apenas refresca o mapa sem mostrar janela.
System.Int32 iNumCopias

Número de cópias.
System.String sDocumento

Indica se o mapa corresponde a um documento.
System.String sSelFormula

Selection formula.
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao

Sentido de ordenação.
System.Boolean bCategoria

Categoria de mapas.
System.Boolean bMapaSistema

Indica se o mapa é de sistema.
System.String sQuerySQL

Query SQL a utilizar para obter os dados do mapa.
System.Boolean blnModal

Modo de janela de pré-visualização a usar na impressão do mapa.
StdBETipos.EnumGlobalCultures eCultura

Cultura a usar na impressão do mapa (se suportada).
System.Boolean blnImpressaoCheque
System.String strUniqueIdentifier

Identificador único utilizado nas tabelas temporárias.
Returns
Type Description
System.Int32

ImprimeListagemDirecta(String, ref String)

Impressão de um mapa de impressão directa (.RPD).

Declaration
public int ImprimeListagemDirecta(string sReport, ref string sTitulo)
Parameters
Type Name Description
System.String sReport

Nome do mapa.
System.String sTitulo

Título do mapa.
Returns
Type Description
System.Int32

ImprimeListagemInstAdm()

Declaration
public int ImprimeListagemInstAdm()
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String)

Declaration
public int ImprimeListagemInstAdm(string sReport)
Parameters
Type Name Description
System.String sReport
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String)

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String, String)

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo, string sDestino)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String, String, Int32)

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo, string sDestino, int iNumCopias)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String, String, Int32, String)

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String, String, Int32, String, ref String)

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, ref string sSelFormula)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String, String, Int32, String, ref String, StdBSTipos.CRPESentidoOrdenacao)

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, ref string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String, String, Int32, String, ref String, StdBSTipos.CRPESentidoOrdenacao, Boolean)

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, ref string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bMapaSistema)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
System.Boolean bMapaSistema
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String, String, Int32, String, ref String, StdBSTipos.CRPESentidoOrdenacao, Boolean, String)

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, ref string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bMapaSistema, string sQuerySQL)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
System.Boolean bMapaSistema
System.String sQuerySQL
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String, String, Int32, String, ref String, StdBSTipos.CRPESentidoOrdenacao, Boolean, String, Boolean)

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, ref string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bMapaSistema, string sQuerySQL, bool blnModal)
Parameters
Type Name Description
System.String sReport
System.String sTitulo
System.String sDestino
System.Int32 iNumCopias
System.String sDocumento
System.String sSelFormula
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao
System.Boolean bMapaSistema
System.String sQuerySQL
System.Boolean blnModal
Returns
Type Description
System.Int32

ImprimeListagemInstAdm(String, String, String, Int32, String, ref String, StdBSTipos.CRPESentidoOrdenacao, Boolean, String, Boolean, StdBETipos.EnumGlobalCultures)

Impressão de um mapa.

Declaration
public int ImprimeListagemInstAdm(string sReport, string sTitulo, string sDestino, int iNumCopias, string sDocumento, ref string sSelFormula, StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao, bool bMapaSistema, string sQuerySQL, bool blnModal, StdBETipos.EnumGlobalCultures eCultura)
Parameters
Type Name Description
System.String sReport

Nome do mapa.
System.String sTitulo

Título do mapa.
System.String sDestino

Destino.
System.Int32 iNumCopias

Número de cópias.
System.String sDocumento

Indica se o mapa corresponde a um documento.
System.String sSelFormula

Selection formula.
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao

Sentido de ordenação.
System.Boolean bMapaSistema

Indica se o mapa é de sistema.
System.String sQuerySQL

Query SQL a utilizar para obter os dados do mapa.
System.Boolean blnModal

Modo de janela de pré-visualização a usar na impressão do mapa.
StdBETipos.EnumGlobalCultures eCultura

Cultura a usar na impressão do mapa (se suportada).
Returns
Type Description
System.Int32

Inicializar(String)

Método de inicialização da impressão.

Declaration
public void Inicializar(string strApl)
Parameters
Type Name Description
System.String strApl

Abreviatura da aplicação.
Remarks

Este método deve ser invocado antes de qualquer outro ao preparar a impressão de um mapa.

InicializaReportViewer(Object)

Inicializa o Report Viewer.

Declaration
public void InicializaReportViewer(dynamic objEventHandler = null)
Parameters
Type Name Description
System.Object objEventHandler

Classe que recebe os eventos lançados pelo Report Viewer.

InicializarInstAdm(String, String, String, String)

Método de inicialização da impressão do Instance Administrator.

Declaration
public void InicializarInstAdm(string strServidor, string strBaseDados, string strUtilizador, string strPassword)
Parameters
Type Name Description
System.String strServidor

Nome do servidor.
System.String strBaseDados

Nome da base de dados.
System.String strUtilizador

Nome do utilizador.
System.String strPassword

Palavra-chave.

ListaMapas(String, String, ref String[,], ref Int32, Object, String)

Devolve uma lista de todos os mapas existentes numa categoria.

Declaration
public bool ListaMapas(string strApl, string strCategoria, ref string[, ] strMapas, ref int intDefaultIndex, dynamic objControlo = null, string strEmpresa = "")
Parameters
Type Name Description
System.String strApl
System.String strCategoria
System.String[,] strMapas
System.Int32 intDefaultIndex
System.Object objControlo
System.String strEmpresa
Returns
Type Description
System.Boolean

LoadPrinterSettings()

Loads the printer settings.

Declaration
public PrinterSettings LoadPrinterSettings()
Returns
Type Description
System.Drawing.Printing.PrinterSettings

LoadPrinterSettings(Boolean)

Loads the printer settings.

Declaration
public PrinterSettings LoadPrinterSettings(bool defaultPrinter)
Parameters
Type Name Description
System.Boolean defaultPrinter

if set to true [default printer].
Returns
Type Description
System.Drawing.Printing.PrinterSettings

MergePdfVertically(ref Byte[], ref Byte[], ref Byte[])

Junção de dois ficheiros PDF

Declaration
public void MergePdfVertically(ref byte[] streamA, ref byte[] streamB, ref byte[] destinationStream)
Parameters
Type Name Description
System.Byte[] streamA

stream do primeiro PDF
System.Byte[] streamB

stream do segundo PDF
System.Byte[] destinationStream

MotorOperacional()

Indica se o Motor de Impressão se encontra activo / desactivo.

Declaration
public bool MotorOperacional()
Returns
Type Description
System.Boolean

NumeroMapas(String, String)

Devolve o número de mapas existentes para determinada categoria.

Declaration
public int NumeroMapas(string strApl, string strCategoria)
Parameters
Type Name Description
System.String strApl

Abreviatura da aplicação.
System.String strCategoria

Nome da categoria.
Returns
Type Description
System.Int32

OrientacaoFolha(StdBSTipos.CRPEOrientacaoFolha)

Orientação da folha.

Declaration
public int OrientacaoFolha(StdBSTipos.CRPEOrientacaoFolha eOpcao)
Parameters
Type Name Description
StdPlatBS100.StdBSTipos.CRPEOrientacaoFolha eOpcao

Orientação da folha.
Returns
Type Description
System.Int32

ReimprimeListagem()

Reimpressão da última listagem efectuada.

Declaration
public bool ReimprimeListagem()
Returns
Type Description
System.Boolean

ReportRefresh(String)

Efectua o refresh da impressão.

Declaration
public void ReportRefresh(string strSessionId)
Parameters
Type Name Description
System.String strSessionId

Id da sessão de impressão

SetDataBaseConnection(String, String, String, String)

Método que permite definir a fonte de dados do report.

Declaration
public void SetDataBaseConnection(string strServidor, string strNomeBaseDados, string strLogin, string strPassword)
Parameters
Type Name Description
System.String strServidor

Servidor onde se encontra a Base de Dados.
System.String strNomeBaseDados

Nome da Base de Dados.
System.String strLogin

Nome de Utilizador para efectuar o login no servidor.
System.String strPassword

Password para efectuar o login no servidor.

SetDimFolha(Int32, Int32)

Definição da dimensão da folha.

Declaration
public void SetDimFolha(int iComprimento, int iAltura)
Parameters
Type Name Description
System.Int32 iComprimento

Comprimento.
System.Int32 iAltura

Altura.

SetFileProp(StdBSTipos.CRPEExportFormat, String)

Definição das propriedades do ficheiro de exportação.

Declaration
public void SetFileProp(StdBSTipos.CRPEExportFormat eFormato, string sNomeFich = "")
Parameters
Type Name Description
StdPlatBS100.StdBSTipos.CRPEExportFormat eFormato

Formato de exportação.
System.String sNomeFich

Nome do ficheiro.

SetFormula(String, String)

Declaration
public void SetFormula(string sNomeFormula, string sFormula)
Parameters
Type Name Description
System.String sNomeFormula
System.String sFormula

SetGroupOptions(String, Int32, StdBSTipos.CRPESentidoOrdenacao)

Definição de opções de grupo.

Declaration
public void SetGroupOptions(string sNomeCampo, int iNumeroGrupo, StdBSTipos.CRPESentidoOrdenacao eSentido)
Parameters
Type Name Description
System.String sNomeCampo

Nome do campo.
System.Int32 iNumeroGrupo

Número do grupo.
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentido

Sentido.

SetMailProp(String, String, String, String)

Definição de propriedades do envio do mapa por email.

Declaration
public void SetMailProp(string sEnderecosTO, string sEnderecosCC, string sAssunto, string sMensagem)
Parameters
Type Name Description
System.String sEnderecosTO

Campo TO.
System.String sEnderecosCC

Campo CC.
System.String sAssunto

Assunto da mensagem.
System.String sMensagem

Corpo da mensagem.

SetMargens(Int32, Int32, Int32, Int32)

Definição das margens de impressão.

Declaration
public void SetMargens(int iMrgEsqPapel, int iMrgDirPapel, int iMrgCabPapel, int iMrgRodPapel)
Parameters
Type Name Description
System.Int32 iMrgEsqPapel

Margem esquerda.
System.Int32 iMrgDirPapel

Margem direita.
System.Int32 iMrgCabPapel

Margem cabeçalho.
System.Int32 iMrgRodPapel

Margem rodapé.

SetMSExchProp(String, String, String)

Definição de propriedades do envio por email usando MSExchange.

Declaration
public void SetMSExchProp(string sProfile, string sPassword, string sFolderPath)
Parameters
Type Name Description
System.String sProfile

Nome do perfil.
System.String sPassword

Password.
System.String sFolderPath

Pasta.

SetOrdenacao(StdBSTipos.CRPESentidoOrdenacao, String)

Definição de ordenações.

Declaration
public void SetOrdenacao(StdBSTipos.CRPESentidoOrdenacao eSentido, string sCampos)
Parameters
Type Name Description
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao eSentido

Sentido.
System.String sCampos

Campos.

SetParametro(String, Object)

Definição do valor de parâmetros.

Declaration
public void SetParametro(string sNomeParametro, dynamic vValor)
Parameters
Type Name Description
System.String sNomeParametro

Nome do parâmetro.
System.Object vValor

Valor.

SetPrinter(String, String, String)

Definção da impressora.

Declaration
public void SetPrinter(string sNomeImpressora, string sNomeDriver, string sPorta)
Parameters
Type Name Description
System.String sNomeImpressora

Nome da impressora.
System.String sNomeDriver

Driver.
System.String sPorta

Porta.

SetSectionFormat(StdBSTipos.CRPESections, StdBSTipos.CRPEWhatFlagSection, StdBSTipos.CRPEFlagSection)

Definição de formatações de secção.

Declaration
public void SetSectionFormat(StdBSTipos.CRPESections rCodigoSeccao, StdBSTipos.CRPEWhatFlagSection eSectionFlag, StdBSTipos.CRPEFlagSection eFlagValue)
Parameters
Type Name Description
StdPlatBS100.StdBSTipos.CRPESections rCodigoSeccao

Secção.
StdPlatBS100.StdBSTipos.CRPEWhatFlagSection eSectionFlag

Flag (secção).
StdPlatBS100.StdBSTipos.CRPEFlagSection eFlagValue

Flag.

TerminaEnumeracao()

Terminas the enumeracao.

Declaration
public void TerminaEnumeracao()

TerminaJanelas()

Fecha todas as janelas resultantes da pré-visualização de mapas.

Declaration
public void TerminaJanelas()

UsaImpressoraPorDefeito()

Definição se a impressão dos mapas deve utilizar a impressora por defeito do sistema operativo.

Declaration
public void UsaImpressoraPorDefeito()

VersaoMotorCrystal()

Devolve a versão instalado do Crystal Reports.

Declaration
public int VersaoMotorCrystal()
Returns
Type Description
System.Int32

WritePdfWatermark(ref Byte[], ref Byte[], Int32, Int32, Int32, Int32, String, Double, String)

desenha um texto no pdf especificado.

Declaration
public void WritePdfWatermark(ref byte[] sourceStream, ref byte[] destinationStream, int x, int y, int Width, int Height, string fontFamily, double fontSize, string Text)
Parameters
Type Name Description
System.Byte[] sourceStream

documento origem
System.Byte[] destinationStream

documento destino
System.Int32 x
System.Int32 y
System.Int32 Width

largura do rectangulo
System.Int32 Height
System.String fontFamily

tipo de letra
System.Double fontSize

tamanho de letra
System.String Text

Implements