Class StdBSMapas

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

Inheritance

System.Object

StdBSMapas

Implements

IStdBSMapas

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("FE9B36B5-4485-4F2D-83A9-9737FAD02D02")]
[ClassInterface(ClassInterfaceType.None)]
public class StdBSMapas : IStdBSMapas

Properties

ActiveBar

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

Declaration

public dynamic ActiveBar { get; }

Property Value

Type	Description
System.Object

AditionalCacheKey

Token adicional para a chave da cache

Declaration

public string AditionalCacheKey { set; }

Property Value

Type	Description
System.String

AplicacaoRegrasCertificacao

Define qual a aplicação a validar no ficheiro de regras de certificação

Declaration

public string AplicacaoRegrasCertificacao { get; set; }

Property Value

Type	Description
System.String

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

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

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)

Adicionar uma condição de grupo (booleana).

Declaration

public void AddBoolGroupCondition(StdBSTipos.CRPESections rCodSeccao, string sCampoBool, StdBSTipos.CRPEBoolTrigger eCondicao, StdBSTipos.CRPESentidoOrdenacao eSentido)

Parameters

Type	Name	Description
StdPlatBS100.StdBSTipos.CRPESections	rCodSeccao	Secção.
System.String	sCampoBool	Campo booleano.
StdPlatBS100.StdBSTipos.CRPEBoolTrigger	eCondicao	Condição.
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao	eSentido	Sentido.

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

Adiciona uma condição de grupo (campo data).

Declaration

public void AddDateGroupCondition(StdBSTipos.CRPESections rCodSeccao, string sCampoData, StdBSTipos.CRPEDateTrigger eCondicao, StdBSTipos.CRPESentidoOrdenacao eSentido)

Parameters

Type	Name	Description
StdPlatBS100.StdBSTipos.CRPESections	rCodSeccao	Secção.
System.String	sCampoData	Campo data.
StdPlatBS100.StdBSTipos.CRPEDateTrigger	eCondicao	Condição.
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao	eSentido	Sentido.

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(StdBSMapas2008, String, String, String, Boolean)

Adds the formula sub report.

Declaration

public void AddFormulaSubReport(StdBSMapas2008 objMapas, string sNomeSubReport, string sNomeFormula, string sFormula, bool bTrataPlicas = true)

Parameters

Type	Name	Description
StdBSMapas2008	objMapas	The object mapas.
System.String	sNomeSubReport	The s nome sub report.
System.String	sNomeFormula	The s nome formula.
System.String	sFormula	The s formula.
System.Boolean	bTrataPlicas	if set to true [b trata plicas].

AddFormulaSubReport(String, String, String, Boolean)

Adiciona uma fórmula ao sub report de um mapa.

Declaration

public void AddFormulaSubReport(string sNomeSubReport, string sNomeFormula, string sFormula, bool bTrataPlicas = true)

Parameters

Type	Name	Description
System.String	sNomeSubReport	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.

AddOfflineContext(String, Object)

Adds the offline context.

Declaration

public void AddOfflineContext(string contextKey, object value)

Parameters

Type	Name	Description
System.String	contextKey	The context key.
System.Object	value	The value.

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 parâmetro ao mapa.

Declaration

public void AddParametro(string sNomeParametro, dynamic vValor)

Parameters

Type	Name	Description
System.String	sNomeParametro	Nome do parâmetro.
System.Object	vValor	Valor.

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	Tabela origem.
System.String	sTabelaDestino	Tabela destino.
System.String[]	sCamposOrigem	Campos origem.
System.String[]	sCamposDestino	Campos destino.
crLinkJoinType	eTipoJoin	Tipo de junção.

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

CriaMotorImpressao()

Define versão do motor de impressão.

Declaration

public void CriaMotorImpressao()

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

DecriptaFicheiroRegrasCertificacao()

Descripta o ficheiro de regras de certificação.

Declaration

public XmlDocument DecriptaFicheiroRegrasCertificacao()

Returns

Type	Description
System.Xml.XmlDocument

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
System.Int32	lFolhaComp
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.

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
System.Int32	lFolhaComp
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(Byte[], ref Byte[])

Termina uma sessão de impressão.

Declaration

public void DuplicatePdfSideBySide(byte[] sourceStream, ref byte[] destinationStream)

Parameters

Type	Name	Description
System.Byte[]	sourceStream	documento origem
System.Byte[]	destinationStream	documento destino

ExportPrintSessionToFile(String, String, StdBSTipos.CRPEExportDestino)

Termina uma sessão de impressão.

Declaration

public void ExportPrintSessionToFile(string strPrintSessionId, 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, Byte[])

Termina uma sessão de impressão.

Declaration

public void ExportPrintSessionToMemory(string strPrintSessionId, byte[] arrByte)

Parameters

Type	Name	Description
System.String	strPrintSessionId	Id da sessão de impressão
System.Byte[]	arrByte

ExportPrintSessionToStream(String)

Exporta o mapa para uma System.IO.Stream

Declaration

public Stream ExportPrintSessionToStream(string strPrintSessionId)

Parameters

Type	Name	Description
System.String	strPrintSessionId

Returns

Type	Description
System.IO.Stream

Finalize()

Finalizes an instance of the StdBSMapas class.

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)

Declaration

public StdBSTipos.TCategMapa GetCategInfo(string strApl, string strCategoria)

Parameters

Type	Name	Description
System.String	strApl
System.String	strCategoria

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(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 = "W", int iNumCopias = 1, string sDocumento = "N", string sSelFormula = "", StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao = StdBSTipos.CRPESentidoOrdenacao.soNenhuma, bool bCategoria = false, bool bMapaSistema = false, string sQuerySQL = "", bool blnModal = false, StdBETipos.EnumGlobalCultures eCultura = StdBETipos.EnumGlobalCultures.CULT_UNDEF, bool blnImpressaoCheque = false, string strUniqueIdentifier = "")

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	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 para utilização nas tabelas temporárias.

Returns

Type	Description
System.Int32

ImprimeListagemDirecta(String, String)

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

Declaration

public int ImprimeListagemDirecta(string sReport, string sTitulo)

Parameters

Type	Name	Description
System.String	sReport	Nome do mapa.
System.String	sTitulo	Título do mapa.

Returns

Type	Description
System.Int32

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

Imprimes the offline listagem.

Declaration

public void ImprimeListagemOffline(string sReport = "", string sTitulo = "", string sDestino = "W", int iNumCopias = 1, string sDocumento = "N", string sSelFormula = "", StdBSTipos.CRPESentidoOrdenacao eSentidoOrdenacao = StdBSTipos.CRPESentidoOrdenacao.soNenhuma, bool bCategoria = false, bool bMapaSistema = false, string sQuerySQL = "", bool blnModal = false, StdBETipos.EnumGlobalCultures eCultura = StdBETipos.EnumGlobalCultures.CULT_UNDEF, bool blnImpressaoCheque = false, string strUniqueIdentifier = "")

Parameters

Type	Name	Description
System.String	sReport	The s report.
System.String	sTitulo	The s titulo.
System.String	sDestino	The s destino.
System.Int32	iNumCopias	The i number copias.
System.String	sDocumento	The s documento.
System.String	sSelFormula	The s sel formula.
StdPlatBS100.StdBSTipos.CRPESentidoOrdenacao	eSentidoOrdenacao	The e sentido ordenacao.
System.Boolean	bCategoria	if set to true [b categoria].
System.Boolean	bMapaSistema	if set to true [b mapa sistema].
System.String	sQuerySQL	The s query SQL.
System.Boolean	blnModal	if set to true [BLN modal].
StdBETipos.EnumGlobalCultures	eCultura	The e cultura.
System.Boolean	blnImpressaoCheque	if set to true [BLN impressao cheque].
System.String	strUniqueIdentifier	The string unique identifier.

Exceptions

Type	Condition
System.Exception

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.

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.

InicializarImpressaoCertificada(String, String, String)

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

Declaration

public void InicializarImpressaoCertificada(string strApl, string strCategoria, string strRegra = "")

Parameters

Type	Name	Description
System.String	strApl	Abreviatura da aplicação.
System.String	strCategoria	Categoria do mapa
System.String	strRegra

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	Nome da categoria.
System.String[,]	strMapas	Lista de mapas (resultado).
System.Int32	intDefaultIndex	Índice por defeito de oControlo.
System.Object	objControlo	Controlo a preencher com os resultados.
System.String	strEmpresa	Identificador da empresa (lista apenas os mapas disponíveis para esta empresa).

Returns

Type	Description
System.Boolean

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

Devolve uma lista de todos os mapas existentes numa categoria.

Declaration

public bool ListaMapasEx(string strApl, string strCategoria, ref string[, ] strMapas, ref int intDefaultIndex, dynamic objControlo = null, string strEmpresa = "", string strRestricaoSql = "")

Parameters

Type	Name	Description
System.String	strApl
System.String	strCategoria	Nome da categoria.
System.String[,]	strMapas	Lista de mapas (resultado).
System.Int32	intDefaultIndex	Índice por defeito de oControlo.
System.Object	objControlo	Controlo a preencher com os resultados.
System.String	strEmpresa
System.String	strRestricaoSql

Returns

Type	Description
System.Boolean

LoadPrinterSettings()

Loads the printer settings.

Declaration

public PrinterSettings LoadPrinterSettings()

Returns

Type	Description
System.Drawing.Printing.PrinterSettings	The printer settings object.

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

MapaValidado(String)

Mapas the validado.

Declaration

public bool MapaValidado(string strMapa)

Parameters

Type	Name	Description
System.String	strMapa	The string mapa.

Returns

Type	Description
System.Boolean

MapaValidado(String, AdmBEMapa)

indica se o mapa já foi validado para a regra atual

Declaration

public bool MapaValidado(string strMapa, AdmBEMapa objMapa)

Parameters

Type	Name	Description
System.String	strMapa	nome do Mapa
AdmBEMapa	objMapa

Returns

Type	Description
System.Boolean

MapaValido(String)

Mapa é válido?

Declaration

public bool MapaValido(string strMapa)

Parameters

Type	Name	Description
System.String	strMapa	The string mapa.

Returns

Type	Description
System.Boolean

MapaValido(String, AdmBEMapa)

indica se o mapa foi validado e se é válido para alguma regra.

Declaration

public bool MapaValido(string strMapa, AdmBEMapa objMapa)

Parameters

Type	Name	Description
System.String	strMapa	nome do Mapa
AdmBEMapa	objMapa

Returns

Type	Description
System.Boolean

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

Junção de dois ficheiros PDF

Declaration

public void MergePdfVertically(byte[] streamA, 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	stream que retorna a combinação dos dois PDFs

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)

Atríbuição do valor de uma fórmula.

Declaration

public void SetFormula(string sNomeFormula, string sFormula)

Parameters

Type	Name	Description
System.String	sNomeFormula	Nome da fórmula.
System.String	sFormula	Valor da fórmula.

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()

Termina enumeração.

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()

ValidaImpressao(String, String, Boolean)

Valida impressão de um mapa contra as regras da categoria.

Declaration

public StdBEValoresVar ValidaImpressao(string strMapa, string strRegra = "", bool blnForcaValidacao = false)

Parameters

Type	Name	Description
System.String	strMapa	Mapa a validar
System.String	strRegra
System.Boolean	blnForcaValidacao

Returns

Type	Description
StdBEValoresVar

VersaoMotorCrystal()

Devolve a versão instalado do Crystal Reports.

Declaration

public int VersaoMotorCrystal()

Returns

Type	Description
System.Int32

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

desenha um texto no pdf especificado.

Declaration

public void WritePdfWatermark(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	posição do canto esquedo
System.Int32	y	posição do canto superior
System.Int32	Width	largura do rectangulo
System.Int32	Height	altura do rectangulo
System.String	fontFamily	tipo de letra
System.Double	fontSize	tamanho de letra
System.String	Text	texto para desenhar no documento

Events

OnPrintCompleted

This event ocurs after the all print is completed. Is there are several print on the queue, only after the queu is empty this event will be raised

Declaration

public event StdBSMapas.OnPrintCompletedHandler OnPrintCompleted

Event Type

Type	Description
StdBSMapas.OnPrintCompletedHandler

OnPrintReportCompleted

Ocurs on each print.

Declaration

public event StdBSMapas.OnPrintInstanceCompletedHandler OnPrintReportCompleted

Event Type

Type	Description
StdBSMapas.OnPrintInstanceCompletedHandler

Implements

IStdBSMapas