Sign in Join
FPDoc Onlineexperiment

TCSVHandler class

In unit CsvReadWrite

Base class for CSV reading and writing classes.

Declaration

pascal
TCSVHandler = class(TPersistent)

Inheritance

  1. TCSVHandler
  2. TPersistent
  3. TObject

Descends from it: TCSVBuilder TCSVDocument TCSVParser

Description

TCSVHandler is the base class for class TCSVParser which allows you to read a CSV file, and class TCSVBuilder which allows you to write a CSV file. It defines some common properties for these classes, mainly to describe the formatting of the CSV file, such as the Delimiter or QuoteChar and LineEnding properties.

Normally you will not create an instance of TCSVHandler, instead you will create a TCSVParser or TCSVBuilder instance.

See also

Properties

DelimiterpublicField delimiter character.
QuoteCharpublicCharacter to quote values.
LineEndingpublicLine ending character.
IgnoreOuterWhitespacepublicIgnore whitespace between delimiters and field data.
QuoteOuterWhitespacepublicWrite quotes when outer whitespace is found in a value.
EqualColCountPerRowpublicEnsure every row has an equal amount of columns.

Methods

CreatepublicCreate an instance of TCSVHandler.
AssignpublicAssign properties from another TCSVHandler instance.
AssignCSVPropertiespublicAssign properties from another TCSVHandler instance.

Fields

FDelimiterprotected
FQuoteCharprotected
FLineEndingprotected
FSpecialCharsprotected
FDoubleQuoteprotected
FIgnoreOuterWhitespaceprotected
FQuoteOuterWhitespaceprotected
FEqualColCountPerRowprotected

Inherited

From TPersistent (8)

AssignTo DefineProperties Destroy FPOAttachObserver FPODetachObserver FPONotifyObservers GetNamePath GetOwner

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.