Back to Devexpress

CsvDocumentImporterOptions Members

officefileapi-devexpress-dot-xtraspreadsheet-dot-import-dot-csvdocumentimporteroptions-dot-underscore-members.md

latest7.9 KB
Original Source

CsvDocumentImporterOptions Members

Contains options used for loading (importing) a document in CSV format.

Constructors

NameDescription
CsvDocumentImporterOptions()Initializes a new instance of the CsvDocumentImporterOptions class with the default settings.

Properties

NameDescription
AutoDetectDelimiterGets or sets a value indicating whether to automatically detect a character separating values in the CSV file.
AutoDetectEncodingGets or sets whether the spreadsheet attempts to detect encoding of the text being imported.
CellIndexOutOfRangeStrategyGets or sets the action performed when the spreadsheet cannot assign imported data to a cell.
CellReferenceStyleGets or sets the cell reference style used in a source document.
ClearWorksheetBeforeImportGets or sets whether to clear a worksheet before importing data.
ColumnTypesProvides access to the object which enables you to specify the data types for columns in an imported document.
CultureGets or sets culture information used to parse imported data.
DelimiterGets or sets the character that separates values in the text.
EncodingGets or sets the encoding used to interpret characters in the loaded CSV document.
MaxRowCountToAutoDetectDelimiterGets or sets the number of rows that should be analyzed to automatically detect the character separating values in the CSV file.
MaxRowCountToImportGets or sets the maximum number of rows which will be filled with imported data in the resulting worksheet.
NewlineTypeGets or sets a character sequence used to define a new line.
StartCellToInsertGets or sets the upper left cell of the imported data range.
StartRowToImportGets or sets the row index of imported data starting from which the data are placed in worksheet cells.
TextQualifierGets or sets the character that encloses values in the source text.
TrimBlanksGets or sets whether to remove all leading and trailing white-space characters from each imported string value.
ValueTypeDetectModeGets or sets the level of complexity to which the type of imported value is recognized.
WorksheetGets or sets a destination worksheet into which data is imported.

Methods

NameDescription
Assign(BaseOptions)Copies all settings from the options object passed as a parameter. Inherited from BaseOptions.
BeginUpdate()Locks the BaseOptions object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. Inherited from BaseOptions.
CancelUpdate()Unlocks the BaseOptions object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseOptions.
Clone()Creates a copy of the current CsvDocumentImporterOptions object.
EndUpdate()Unlocks the BaseOptions object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseOptions.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ToString()Returns a string representing the currently enabled options. Inherited from BaseOptions.

See Also

CsvDocumentImporterOptions Class

DevExpress.XtraSpreadsheet.Import Namespace