Class to keep information about form letter creation process for finance letters More...

Inheritance diagram for Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo:

Public Member Functions
	TFormLetterFinanceInfo (List< String >ATagList, String AFileName, Int32 AFormalityLevel=1)
	constructor More...

void	SetOptionsFromFinanceForm (String AOptions)
	set properties through interpretation of option string stored in database More...

void	AddFormality (String ALanguageCode, String ACountryCode, String AAddresseeTypeCode, Int32 AFormalityLevel, String ASalutationText, String AClosingText)
	initialize formality structures More...

Boolean	IsFormalityInitialized ()
	check if formality list is already initialized More...

Boolean	RetrieveFormalityGreeting (TFormDataPartner AFormDataPartner, out String ASalutationText, out String AClosingText)
	retrieve salutation and closing text from the best formality record match, according to formality level and other criteria. This assumes that AFormDataPartner is already filled with name information needed for producing greetings. More...

Boolean	RetrieveFormalityGreeting (String ALanguageCode, String ACountryCode, String AAddresseeTypeCode, out String ASalutationText, out String AClosingText)
	retrieve salutation and closing text from the best formality record match, according to formality level and other criteria. This assumes that AFormDataPartner is already filled with name information needed for producing greetings. More...

Boolean	IsRetrievalRequested (TFormDataRetrievalSection ASection)
	check if retrieval of data is requested for a certain section More...

Boolean	ContainsTag (String ATag)
	check if tag list contains certain tag More...

void	AddFormLetterPrintOptions (string AMailingCode, string APublicationCodes)
	This constructor sets all the Form Letter print options and is set by the GUI More...

Public Attributes
TFormLetterPrintOptions	FormLetterPrintOptions = null
	A single instance of the options that apply for this Form Letter print run More...

Properties
Decimal	MinimumAmount `[get, set]`
	is there a minimum amount for printing More...

Boolean	AlwaysPrintNewDonor `[get, set]`
	always print if this is a new donor More...

Boolean	GiftsAll `[get, set]`
	print any gift More...

Boolean	GiftsOnly `[get, set]`
	only print if normal gift More...

Boolean	GiftsInKindOnly `[get, set]`
	only print if gift in kind More...

Boolean	GiftsOther `[get, set]`
	only print if neither gift nor gift in kind More...

Boolean	AllAdjustments `[get, set]`
	print no matter if adjustment or not More...

Boolean	IncludeAdjustmentsOnly `[get, set]`
	only print adjustments More...

Boolean	ExcludeAdjustments `[get, set]`
	only print if not adjustment More...

String	FileName `[get, set]`
	File name More...

String	AddressLayoutCode `[get, set]`
	address layout code to be used More...

Int32	FormalityLevel `[get, set]`
	Formality Level More...

bool	SplitEmailAddresses `[get, set]`
	If this is true multiple email addresses are split and applied one by one to the same partner on multiple rows More...

int	CurrentEmailInstance `[get, set]`
	Value used internally to specify a pointer into one of multiple email addresses More...

int	NextEmailInstance `[get, set]`
	Value used internally to specify the next pointer to use where there are multiple email addresses More...

Detailed Description

Class to keep information about form letter creation process for finance letters

Constructor & Destructor Documentation

◆ TFormLetterFinanceInfo()

Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.TFormLetterFinanceInfo	(	List< String >	ATagList,
		String	AFileName,
		Int32	AFormalityLevel = `1`
	)

inline

constructor

Member Function Documentation

◆ AddFormality()

void Ict.Petra.Shared.MCommon.TFormLetterInfo.AddFormality	(	String	ALanguageCode,
		String	ACountryCode,
		String	AAddresseeTypeCode,
		Int32	AFormalityLevel,
		String	ASalutationText,
		String	AClosingText
	)

inlineinherited

initialize formality structures

Parameters

ALanguageCode
ACountryCode
AAddresseeTypeCode
AFormalityLevel
ASalutationText
AClosingText

Returns

◆ AddFormLetterPrintOptions()

void Ict.Petra.Shared.MCommon.TFormLetterInfo.AddFormLetterPrintOptions	(	string	AMailingCode,
		string	APublicationCodes
	)

inlineinherited

This constructor sets all the Form Letter print options and is set by the GUI

Parameters

AMailingCode
APublicationCodes

◆ ContainsTag()

Boolean Ict.Petra.Shared.MCommon.TFormLetterInfo.ContainsTag ( String ATag )

inlineinherited

check if tag list contains certain tag

Parameters

ATag

Returns

◆ IsFormalityInitialized()

Boolean Ict.Petra.Shared.MCommon.TFormLetterInfo.IsFormalityInitialized ( )

inlineinherited

check if formality list is already initialized

Returns: true if formality list is initialized

◆ IsRetrievalRequested()

Boolean Ict.Petra.Shared.MCommon.TFormLetterInfo.IsRetrievalRequested ( TFormDataRetrievalSection ASection )

inlineinherited

check if retrieval of data is requested for a certain section

Parameters

ASection

Returns

◆ RetrieveFormalityGreeting() [1/2]

Boolean Ict.Petra.Shared.MCommon.TFormLetterInfo.RetrieveFormalityGreeting	(	String	ALanguageCode,
		String	ACountryCode,
		String	AAddresseeTypeCode,
		out String	ASalutationText,
		out String	AClosingText
	)

inlineinherited

retrieve salutation and closing text from the best formality record match, according to formality level and other criteria. This assumes that AFormDataPartner is already filled with name information needed for producing greetings.

Parameters

ALanguageCode	form letter data object to be used and filled
ACountryCode	form letter data object to be used and filled
AAddresseeTypeCode	form letter data object to be used and filled
ASalutationText	out: saluation text (inserts not replaced yet)
AClosingText	out: closing text (inserts not replaced yet)

Returns: true if salutation and closing text could successfully retrieved

◆ RetrieveFormalityGreeting() [2/2]

Boolean Ict.Petra.Shared.MCommon.TFormLetterInfo.RetrieveFormalityGreeting	(	TFormDataPartner	AFormDataPartner,
		out String	ASalutationText,
		out String	AClosingText
	)

inlineinherited

retrieve salutation and closing text from the best formality record match, according to formality level and other criteria. This assumes that AFormDataPartner is already filled with name information needed for producing greetings.

Parameters

AFormDataPartner	form letter data object to be used and filled
ASalutationText	out: saluation text (inserts not replaced yet)
AClosingText	out: closing text (inserts not replaced yet)

Returns: true if salutation and closing text could successfully retrieved

◆ SetOptionsFromFinanceForm()

void Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.SetOptionsFromFinanceForm ( String AOptions )

inline

set properties through interpretation of option string stored in database

Parameters

AOptions

Member Data Documentation

◆ FormLetterPrintOptions

TFormLetterPrintOptions Ict.Petra.Shared.MCommon.TFormLetterInfo.FormLetterPrintOptions = null

inherited

A single instance of the options that apply for this Form Letter print run

Property Documentation

◆ AddressLayoutCode

String Ict.Petra.Shared.MCommon.TFormLetterInfo.AddressLayoutCode

getsetinherited

address layout code to be used

◆ AllAdjustments

Boolean Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.AllAdjustments

getset

print no matter if adjustment or not

◆ AlwaysPrintNewDonor

Boolean Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.AlwaysPrintNewDonor

getset

always print if this is a new donor

◆ CurrentEmailInstance

int Ict.Petra.Shared.MCommon.TFormLetterInfo.CurrentEmailInstance

getsetinherited

Value used internally to specify a pointer into one of multiple email addresses

◆ ExcludeAdjustments

Boolean Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.ExcludeAdjustments

getset

only print if not adjustment

◆ FileName

String Ict.Petra.Shared.MCommon.TFormLetterInfo.FileName

getsetinherited

File name

◆ FormalityLevel

Int32 Ict.Petra.Shared.MCommon.TFormLetterInfo.FormalityLevel

getsetinherited

Formality Level

◆ GiftsAll

Boolean Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.GiftsAll

getset

print any gift

◆ GiftsInKindOnly

Boolean Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.GiftsInKindOnly

getset

only print if gift in kind

◆ GiftsOnly

Boolean Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.GiftsOnly

getset

only print if normal gift

◆ GiftsOther

Boolean Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.GiftsOther

getset

only print if neither gift nor gift in kind

◆ IncludeAdjustmentsOnly

Boolean Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.IncludeAdjustmentsOnly

getset

only print adjustments

◆ MinimumAmount

Decimal Ict.Petra.Shared.MCommon.TFormLetterFinanceInfo.MinimumAmount

getset

is there a minimum amount for printing

◆ NextEmailInstance

int Ict.Petra.Shared.MCommon.TFormLetterInfo.NextEmailInstance

getsetinherited

Value used internally to specify the next pointer to use where there are multiple email addresses

◆ SplitEmailAddresses

bool Ict.Petra.Shared.MCommon.TFormLetterInfo.SplitEmailAddresses

getsetinherited

If this is true multiple email addresses are split and applied one by one to the same partner on multiple rows

The documentation for this class was generated from the following file:

csharp/ICT/Petra/Shared/lib/MCommon/FormData.cs

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TFormLetterFinanceInfo()

Member Function Documentation

◆ AddFormality()

◆ AddFormLetterPrintOptions()

◆ ContainsTag()

◆ IsFormalityInitialized()

◆ IsRetrievalRequested()

◆ RetrieveFormalityGreeting() [1/2]

◆ RetrieveFormalityGreeting() [2/2]

◆ SetOptionsFromFinanceForm()

Member Data Documentation

◆ FormLetterPrintOptions

Property Documentation

◆ AddressLayoutCode

◆ AllAdjustments

◆ AlwaysPrintNewDonor

◆ CurrentEmailInstance

◆ ExcludeAdjustments

◆ FileName

◆ FormalityLevel

◆ GiftsAll

◆ GiftsInKindOnly

◆ GiftsOnly

◆ GiftsOther

◆ IncludeAdjustmentsOnly

◆ MinimumAmount

◆ NextEmailInstance

◆ SplitEmailAddresses