Table of Contents

Class AbstractReportVO

Namespace
PHCBusinessLayer
Assembly
PHCBusinessLayer.dll

Classe abstracta AbstractReportVO

public class AbstractReportVO : BaseBuilderVO, IBaseSerialization, ICloneVO, ICloneable, IChange, IParent, IGenericVO
Inheritance
AbstractReportVO

Remarks

Classe que define a base de um relatório. Não deve de ser utilizado directamente mas ser implementado através de uma subclasse. .

BaseReportVO

Properties

Cm1VO

[AttExternalCollection(typeof(Cm1VO), new string[] { "[Cm1].[cm]", "[Tabax].[docid]" })]
public Cm1VO Cm1VO { get; }

Property Value

Cm1VO

PcyVO

[AttExternalCollection(typeof(PcyVO), new string[] { "[PCY].[year]", "[Tabax].[docid]" })]
public PcyVO PcyVO { get; }

Property Value

PcyVO

TdVO

[AttExternalCollection(typeof(TdVO), new string[] { "[Td].[ndoc]", "[Tabax].[docid]" })]
public TdVO TdVO { get; }

Property Value

TdVO

TsVO

[AttExternalCollection(typeof(TsVO), new string[] { "[Ts].[ndos]", "[Tabax].[docid]" })]
public TsVO TsVO { get; }

Property Value

TsVO

TsrdVO

[AttExternalCollection(typeof(TsrdVO), new string[] { "[Tsrd].[ndoc]", "[Tabax].[docid]" })]
public TsrdVO TsrdVO { get; }

Property Value

TsrdVO

TsreVO

[AttExternalCollection(typeof(TsreVO), new string[] { "[Tsre].[ndoc]", "[Tabax].[docid]" })]
public TsreVO TsreVO { get; }

Property Value

TsreVO

bytes

public virtual List<byte> bytes { get; set; }

Property Value

List<byte>

chainedDataMember

[AttLenght(100)]
public string chainedDataMember { get; set; }

Property Value

string

children

Hierarquia de componentes

[Obsolete]
public override List<BaseComponentVO> children { get; set; }

Property Value

List<BaseComponentVO>

Remarks

Define a lista de componentes a serem renderizados dentro do relatório.

continuousPaper

Indica se será impresso em papel continuo (Talão)

[AttLenght(1)]
public bool continuousPaper { get; set; }

Property Value

bool

converted

Convertido

[Obsolete]
public bool converted { get; set; }

Property Value

bool

Remarks

Indica se o relatório antigo já foi convertido para o novo formato. Para uso interno da PHC.

dataMember

Membro associado.

[AttLenght(10)]
[Obsolete]
public string dataMember { get; set; }

Property Value

string

Remarks

This field represents each associated entity's type.

Length 10.

E1

docid

Número de categoria de documento

[AttLenght(4)]
public int docid { get; set; }

Property Value

int

Remarks

Contém o nº da categoria do tipo de documento.

Length 4.

docname

[AttVirtualField]
public string docname { get; set; }

Property Value

string

enabled

Activo

[AttFieldType(AttFieldType.InputTypes.boolean)]
[AttList]
public bool enabled { get; set; }

Property Value

bool

Remarks

Indica se o relatório se encontra disponível para ser usado nas impressões.

Length 1 .

Non Duplicable Field

entityType

[AttLenght(100)]
[AttIndex]
[AttMandatory]
public override string entityType { get; set; }

Property Value

string

height

Altura

[AttLenght(5, 0)]
public int height { get; set; }

Property Value

int

Remarks

Contém o valor da altura do relatório. Este valor não é obrigatório pois o Relatório irá herdar do tipo de papel associado.

Só deveria ser definido caso o tipo de papel seja do tipo "Custom".

Length 5.

isDefault

Indica se é o relatório por defeito para a entidade à qual este pertence.

public bool isDefault { get; set; }

Property Value

bool

Remarks

Se este valor estiver a True, então este relatório é o relatório por defeito desta entidade.

Non Duplicable Field

isReadOnly

Modo de leitura

[AttPhcOwner(new string[] { "enabled", "isDefault", "duplicatesQuantity", "imagecolor", "showlogo", "imagesize", "logowidth", "logoheight", "showbaseboard", "showlogobaseboard", "imagebaseboardsize", "logobaseboardwidth", "logobaseboardheight", "passwordfield", "usepassword", "showserialnumbers", "showtaxes" })]
[AttFieldType(AttFieldType.InputTypes.boolean)]
public bool isReadOnly { get; set; }

Property Value

bool

Remarks

Indica se o relatório se encontra em modo de leitura. Caso o valor seja "true", indica que é um relatório gerado pela PHC.

Este campo é reservado para uso da PHC exclusivamente.

Non Duplicable Field

landscape

Modo paisagem

[AttLenght(1)]
public bool landscape { get; set; }

Property Value

bool

Remarks

Indica se o relatório deverá ser gerado em modo paisagem. Neste modo, os valores da altura e largura são invertidos.

Length 1.

true

language

[AttLenght(3)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttList(Inactive = true)]
public string language { get; set; }

Property Value

string

Remarks

Size (3)

layout

Categoria de Layout

[AttLenght(20)]
[AttMandatory]
[AttList(Inactive = true)]
public string layout { get; set; }

Property Value

string

Remarks

Define a categoria de layout em que deve ser categorizado o relatório. Os valores são "Global","Pro","Design","Minimal".

Por convenção os valores outros que "Global" destinam-se a relatórios relacionados com documentos no então não é obrigatório.

Length 20.

name

[Obsolete]
public string name { get; set; }

Property Value

string

paperKind

Tipo de papel

[AttLenght(15)]
public string paperKind { get; set; }

Property Value

string

Remarks

Indica o tipo de papel a ser utilizado. Os valores actuais suportados são A4,A5,Letter e Custom.

Length 15.

A4 PaperKind

passwordfield

[AttLenght(150)]
public string passwordfield { get; set; }

Property Value

string

passwordfieldname

[AttVirtualField]
[AttHidden]
public string passwordfieldname { get; set; }

Property Value

string

reportgama

Gama do relatório

[AttLenght(50)]
[AttMandatory]
[AttFieldType(AttFieldType.InputTypes.integer)]
[AttList(Inactive = true)]
public int reportgama { get; set; }

Property Value

int

Remarks

Contém a gama do relatório.

Length 50.

reportname

Nome do relatório

[AttLenght(100)]
[AttLogInfo(0)]
[AttMandatory]
[AttList]
public string reportname { get; set; }

Property Value

string

Remarks

Contém o nome do relatório.

Length 50 .

repstamp

Stamp do relatório

[AttLenght(25)]
public string repstamp { get; set; }

Property Value

string

Remarks

Contém o valor do do stamp do relatório.

This field is primary key.

Length 25.

serializationType

Tipo de serialização os objectos na bd

[AttLenght(1)]
[AttHidden]
public SerializerTypeEnum serializationType { get; set; }

Property Value

SerializerTypeEnum

usepassword

public bool usepassword { get; set; }

Property Value

bool

watermarkFont

Fonte da marca de água

[AttLenght(15)]
public string watermarkFont { get; set; }

Property Value

string

Remarks

Define a fonte a ser utilizada pela marca de água.

Length 15.

Arial

watermarkFontSize

[AttLenght(2)]
public int watermarkFontSize { get; set; }

Property Value

int

watermarkForeColor

Cor de texto da marca de água

[AttLenght(10)]
public string watermarkForeColor { get; set; }

Property Value

string

Remarks

Define a cor da fonte da marca de água.

Length 10 .

0

watermarkImage

[AttLenght(25)]
public string watermarkImage { get; set; }

Property Value

string

watermarkImageAlign

Alinhamento da Imagem de marca de água

[AttLenght(12)]
public string watermarkImageAlign { get; set; }

Property Value

string

Remarks

Define o alinhamento da imagem de marca de água.

Length 12 .

ContentAlignment MiddleCenter

watermarkImageMode

[AttLenght(15)]
public string watermarkImageMode { get; set; }

Property Value

string

watermarkImageTiling

Imagem de marca de água em mosaico

public bool watermarkImageTiling { get; set; }

Property Value

bool

Remarks

Define se a imagem deverá ser repetida multiplas vezes.

Length 1 .

watermarkImageTransparency

Transparência da Imagem de marca de água

[AttLenght(3)]
[AttDefaultValue("100")]
public int watermarkImageTransparency { get; set; }

Property Value

int

Remarks

Define a transparência a aplicar à imagem. Um valor de 0 corresponde a uma imagem opaca enquanto que um valor de 100 correponde uma imagem totalmente transparente.

Length 3 .

watermarkShowBehind

Posicionamento da marca de água

public bool watermarkShowBehind { get; set; }

Property Value

bool

Remarks

Define se a marca de água deverá sobrepor-se ao conteúdo ou o inverso.

Length 1 .

watermarkText

Texto de marca de água

[AttLenght(100)]
public string watermarkText { get; set; }

Property Value

string

Remarks

Define o texto a ser utilizado como marca de água. A presença de uma imagem de marca de água fará que o texto seja ignorado.

Length 100 .

watermarkTextDirection

Direcção do texto de marca de água

[AttLenght(15)]
public string watermarkTextDirection { get; set; }

Property Value

string

Remarks

Define a direcção do texto de marca de água.

Length 15 .

DevExpress.XtraPrinting.Drawing.DirectionMode BackwardDiagonal

watermarkTextTransparency

Transparência do texto de marca de água

[AttLenght(3)]
[AttDefaultValue("100")]
public int watermarkTextTransparency { get; set; }

Property Value

int

Remarks

Define a transparência a aplicar ao texto. Um valor de 0 corresponde a um texto opaco enquanto que um valor de 100 correponde um texto totalmente transparente.

Length 3 .

width

Largura

[AttLenght(5, 0)]
public int width { get; set; }

Property Value

int

Remarks

Contém o valor da largura do relatório. Este valor não é obrigatório pois o Relatório irá herdar do tipo de papel associado. Só deveria ser definido caso o tipo de papel seja do tipo "Custom".

Length 5 .

Methods

AfterImport()

public override void AfterImport()

AfterLoad()

public override void AfterLoad()

BeforeSave()

public override void BeforeSave()

updateChildrenIndex()

public void updateChildrenIndex()