Click or drag to resize

AsciiImportOptions Class

Denotes options about how to import data from an ascii text file.
Inheritance Hierarchy
SystemObject
  Altaxo.Serialization.AsciiAsciiImportOptions

Namespace: Altaxo.Serialization.Ascii
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
public class AsciiImportOptions : IImmutable, 
	IEquatable<AsciiImportOptions>

The AsciiImportOptions type exposes the following members.

Constructors
 NameDescription
Public methodAsciiImportOptions Initializes a new instance of the AsciiImportOptions class with default properties.
Top
Properties
 NameDescription
Public propertyCodePage Gets or sets the code page that is used to recognize the Ascii data. To use the system default code page, set this property to 0.
Public propertyDateTimeFormatCultureGets or sets the culture that formats date/time values.
Public propertyDetectEncodingFromByteOrderMarks If true, the encoding is detected from the byte order marks (BOM). If no BOM is present, the encoding according to the CodePage property is used, or, if also not available, the standard encoding.
Public propertyEncoding Gets the encoding. You can set the Encoding setting the CodePage (see CodePage).
Public propertyHeaderLinesDestinationDesignates the destination of main header lines. This option must be set programmatically or by user interaction.
Public propertyImportMultipleStreamsVertically Gets or sets a value indicating whether the import of multiple streams in one table should be horizontally oriented (in more columns) or vertically oriented (in more rows).
Public propertyIndexOfCaptionLineIndex of the line, where we can extract the column names from. ATTENTION: this value is zero based, i.e. if the caption is in the first line, the value is 0. If the value is unkown, the value is null.
Public propertyIsFullySpecified Gets a value indicating whether everything is fully specified now, so that the instance can be used to import Ascii data. If this value is false, the Ascii data have to be analyzed in order to find the missing values.
Public propertyNumberFormatCultureGets or sets the culture that formats numbers.
Public propertyNumberOfMainHeaderLinesNumber of lines to skip (the main header).
Public propertyRecognizedStructureStructure of the main part of the file (which data type is placed in which column).
Public propertyRenameColumnsIf true, rename the columns if 1st line contain the column names. This option must be set programmatically or by user interaction.
Public propertyRenameWorksheetIf true, rename the worksheet to the data file name. This option must be set programmatically or by user interaction.
Public propertyReuseColumnNames Gets a value indicating whether to reuse the column names from the table in which the data will be imported.
Public propertyReuseGroupNumbers Gets a value indicating whether to reuse the group numbers from the table in which the data will be imported.
Public propertySeparationStrategyMethod to separate the tokens in each line of ascii text.
Top
Methods
 NameDescription
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodStatic memberGetDefaultCodePage Gets the default code page for this System. On Windows, this is the ANSI code page, on other systems, it is the default code page.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Top
See Also