Ict.Common.IO Namespace Reference

Namespaces
namespace	Testing

Classes
class	EncryptionRijndael
class	ESmtpSenderException
	Generic emailer exception More...
class	ESmtpSenderInitializeException
	Exception for errors that occur during initialization More...
class	ESmtpSenderSendException
	Exception for errors that occur during sending More...
class	PackTools
	Some helpful wrapper functions for packing and unpacking files and directories. More...
class	ProcessTemplate
	this class helps with template scripts and other text files More...
class	StringBuilderExtensions
	helpful extensions for the StringBuilder More...
class	TCsv2Xml
class	TExcel
	This contains some functions to write into Excel via remote calls constants from http:www.p6c.com/CommonTypelibs/O2000_EXCEL9.CSV More...
class	TFileHelper
	Helps in handling with certain aspects of files and compression. More...
class	THTTPUtils
	a few simple functions to access content from the web More...
class	TImportExportTextFile
	write and read a text file in a format that Petra 2.x uses More...
class	TOpenDocumentParser
class	TSEPAWriterDirectDebit
	Write SEPA files for Direct Debit More...
class	TSimpleYmlParser
	TSimpleYmlParser is mainly used for restoring a database saved as yml.gz; avoids loading a huge XmlDocument with all tables at once. for smaller files, the other implementation, TYml2Xml, is much easier to step through, since you get an XmlDocument More...
class	TsmtpFailedRecipient
	If TSmtpSender.SendMessage can detect that an email didn't reach its recipient (which is not always possible) It will report an array of these as FailedRecipients. More...
class	TSmtpSender
	This is a small wrapper around the .net SMTP Email services More...
struct	TSmtpServerSettings
	Returns the settings to initialize SmtpSender, either to Client or Server More...
class	TTextFile
class	TTextFileEncoding
	A class to handle the various character encoding supported by Open Petra More...
class	TXMLParser
	This class provides methods for parsing an XML document and assign the contents to a representation in memory. More...
class	TYml2Xml
	TYml2Xml is able to parse a YML file and store it in an XmlDocument More...
class	YamlItemOrderComparer
	for sorting the controls, depending on Order attribute, and depth More...

Enumerations
enum	XlChartType {   xl3DArea = -4098 , xl3DAreaStacked = 78 , xl3DAreaStacked100 = 79 , xl3DBarClustered = 60 ,   xl3DBarStacked = 61 , xl3DBarStacked100 = 62 , xl3DColumn = -4100 , xl3DColumnClustered = 54 ,   xl3DColumnStacked = 55 , xl3DColumnStacked100 = 56 , xl3DLine = -4101 , xl3DPie = -4102 ,   xl3DPieExploded = 70 , xlArea = 1 , xlAreaStacked = 76 , xlAreaStacked100 = 77 ,   xlBarClustered = 57 , xlBarOfPie = 71 , xlBarStacked = 58 , xlBarStacked100 = 59 ,   xlBubble = 15 , xlBubble3DEffect = 87 , xlColumnClustered = 51 , xlColumnStacked = 52 ,   xlColumnStacked100 = 53 , xlCloneBarClustered = 102 , xlCloneBarStacked = 103 , xlCloneBarStacked100 = 104 ,   xlCloneCol = 105 , xlCloneColClustered = 99 , xlCloneColStacked = 100 , xlCloneColStacked100 = 101 ,   xlCylinderBarClustered = 95 , xlCylinderBarStacked = 96 , xlCylinderBarStacked100 = 97 , xlCylinderCol = 98 ,   xlCylinderColClustered = 92 , xlCylinderColStacked = 93 , xlCylinderColStacked100 = 94 , xlDoughnut = 4120 ,   xlDoughnutExploded = 80 , xlLine = 4 , xlLineMarkers = 65 , xlLineMarkersStacked = 66 ,   xlLineMarkersStacked100 = 67 , xlLineStacked = 63 , xlLineStacked100 = 64 , xlPie = 5 ,   xlPieExploded = 69 , xlPieOfPie = 68 , xlPyramidBarClustered = 109 , xlPyramidBarStacked = 110 ,   xlPyramidBarStacked100 = 111 , xlPyramidCol = 112 , xlPyramidColClustered = 106 , xlPyramidColStacked = 107 ,   xlPyramidColStacked100 = 108 , xlRadar = -4151 , xlRadarFilled = 82 , xlRadarMarkers = 81 ,   xlStockHLC = 88 , xlStockOHLC = 89 , xlStockVHLC = 90 , xlStockVOHLC = 91 ,   xlSurface = 83 , xlSurfaceTopView = 85 , xlSurfaceTopViewWireframe = 86 , xlSurfaceWireframe = 84 ,   xlXYScatter = -4169 , xlXYScatterLines = 74 , xlXYScatterLinesNoMarkers = 75 , xlXYScatterSmooth = 72 ,   xlXYScatterSmoothNoMarkers = 73 }
	todoComment More...
enum	XlChartLocation { xlLocationAsNewSheet = 1 , xlLocationAsObject = 2 , xlLocationAutomatic = 3 }
	todoComment More...
enum	XlDataLabelsType {   xlDataLabelsShowNone = -4142 , xlDataLabelsShowValue = 2 , xlDataLabelsShowPercent = 3 , xlDataLabelsShowLabel = 4 ,   xlDataLabelsShowLabelAndPercent = 5 , xlDataLabelsShowBubbleSizes = 6 }
	todoComment More...
enum	TSmtpErrorClassEnum { secUnspecified , secServer , secClient }
	Used to distinguish server-config exceptions from client-specified exceptions. More...

Functions
delegate TSmtpServerSettings	TGetSmtpSettings ()
	Delegate to fetch the SMTP server configuration. More...
delegate void	ProcessFileType (string filename)
	delegate to apply an operation on the file More...

Enumeration Type Documentation

TSmtpErrorClassEnum

enum Ict.Common.IO.TSmtpErrorClassEnum

Used to distinguish server-config exceptions from client-specified exceptions.

Enumerator
secUnspecified	Default value
secServer	Error came from server configuration. Exception message should already include "Ask your System Administrator to check the settings in the OpenPetra Server.config file."
secClient	Error cause by client-provided data. Use this value to add a helpful hint to the message appropriate to the client settings. Something like "Check the Email tab in User Settings >> Preferences."

XlChartLocation

enum Ict.Common.IO.XlChartLocation

todoComment

Enumerator
xlLocationAsNewSheet	todoComment
xlLocationAsObject	todoComment
xlLocationAutomatic	todoComment

XlChartType

enum Ict.Common.IO.XlChartType

todoComment

Enumerator
xl3DArea	todoComment
xl3DAreaStacked	todoComment
xl3DAreaStacked100	todoComment
xl3DBarClustered	todoComment
xl3DBarStacked	todoComment
xl3DBarStacked100	todoComment
xl3DColumn	todoComment
xl3DColumnClustered	todoComment
xl3DColumnStacked	todoComment
xl3DColumnStacked100	todoComment
xl3DLine	todoComment
xl3DPie	todoComment
xl3DPieExploded	todoComment
xlArea	todoComment
xlAreaStacked	todoComment
xlAreaStacked100	todoComment
xlBarClustered	todoComment
xlBarOfPie	todoComment
xlBarStacked	todoComment
xlBarStacked100	todoComment
xlBubble	todoComment
xlBubble3DEffect	todoComment
xlColumnClustered	todoComment
xlColumnStacked	todoComment
xlColumnStacked100	todoComment
xlCloneBarClustered	todoComment
xlCloneBarStacked	todoComment
xlCloneBarStacked100	todoComment
xlCloneCol	todoComment
xlCloneColClustered	todoComment
xlCloneColStacked	todoComment
xlCloneColStacked100	todoComment
xlCylinderBarClustered	todoComment
xlCylinderBarStacked	todoComment
xlCylinderBarStacked100	todoComment
xlCylinderCol	todoComment
xlCylinderColClustered	todoComment
xlCylinderColStacked	todoComment
xlCylinderColStacked100	todoComment
xlDoughnut	todoComment
xlDoughnutExploded	todoComment
xlLine	todoComment
xlLineMarkers	todoComment
xlLineMarkersStacked	todoComment
xlLineMarkersStacked100	todoComment
xlLineStacked	todoComment
xlLineStacked100	todoComment
xlPie	todoComment
xlPieExploded	todoComment
xlPieOfPie	todoComment
xlPyramidBarClustered	todoComment
xlPyramidBarStacked	todoComment
xlPyramidBarStacked100	todoComment
xlPyramidCol	todoComment
xlPyramidColClustered	todoComment
xlPyramidColStacked	todoComment
xlPyramidColStacked100	todoComment
xlRadar	todoComment
xlRadarFilled	todoComment
xlRadarMarkers	todoComment
xlStockHLC	todoComment
xlStockOHLC	todoComment
xlStockVHLC	todoComment
xlStockVOHLC	todoComment
xlSurface	todoComment
xlSurfaceTopView	todoComment
xlSurfaceTopViewWireframe	todoComment
xlSurfaceWireframe	todoComment
xlXYScatter	todoComment
xlXYScatterLines	todoComment
xlXYScatterLinesNoMarkers	todoComment
xlXYScatterSmooth	todoComment
xlXYScatterSmoothNoMarkers	todoComment

XlDataLabelsType

enum Ict.Common.IO.XlDataLabelsType

todoComment

Enumerator
xlDataLabelsShowNone	todoComment
xlDataLabelsShowValue	todoComment
xlDataLabelsShowPercent	todoComment
xlDataLabelsShowLabel	todoComment
xlDataLabelsShowLabelAndPercent	todoComment
xlDataLabelsShowBubbleSizes	todoComment

Function Documentation

ProcessFileType()

delegate void Ict.Common.IO.ProcessFileType

(

string

filename

)

delegate to apply an operation on the file

TGetSmtpSettings()

delegate TSmtpServerSettings Ict.Common.IO.TGetSmtpSettings

(

)

Delegate to fetch the SMTP server configuration.

Ultimately these settings come from Server.config. But as TSmtpSender can be instantiated from either Client or Server, we need different routes to get to them.

Returns

TSmtpServerSettings struct containing the settings