Class to keep information about form letter creation process More...

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

Classes
class	Formality
	Class to keep information about formality records More...

class	TFormLetterPrintOptions
	Class to keep information about Form Letter printing options More...

Public Member Functions
	TFormLetterInfo (List< String >ATagList, String AFileName, Int32 AFormalityLevel=1)
	constructor 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
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

Constructor & Destructor Documentation

◆ TFormLetterInfo()

Ict.Petra.Shared.MCommon.TFormLetterInfo.TFormLetterInfo	(	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
	)

inline

initialize formality structures

Parameters

ALanguageCode
ACountryCode
AAddresseeTypeCode
AFormalityLevel
ASalutationText
AClosingText

Returns

◆ AddFormLetterPrintOptions()

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

inline

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 )

inline

check if tag list contains certain tag

Parameters

ATag

Returns

◆ IsFormalityInitialized()

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

inline

check if formality list is already initialized

Returns: true if formality list is initialized

◆ IsRetrievalRequested()

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

inline

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
	)

inline

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
	)

inline

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

Member Data Documentation

◆ FormLetterPrintOptions

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

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

Property Documentation

◆ AddressLayoutCode

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

getset

address layout code to be used

◆ CurrentEmailInstance

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

getset

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

◆ FileName

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

getset

File name

◆ FormalityLevel

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

getset

Formality Level

◆ NextEmailInstance

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

getset

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

◆ SplitEmailAddresses

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

getset

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

Classes

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TFormLetterInfo()

Member Function Documentation

◆ AddFormality()

◆ AddFormLetterPrintOptions()

◆ ContainsTag()

◆ IsFormalityInitialized()

◆ IsRetrievalRequested()

◆ RetrieveFormalityGreeting() [1/2]

◆ RetrieveFormalityGreeting() [2/2]

Member Data Documentation

◆ FormLetterPrintOptions

Property Documentation

◆ AddressLayoutCode

◆ CurrentEmailInstance

◆ FileName

◆ FormalityLevel

◆ NextEmailInstance

◆ SplitEmailAddresses