Flat File Format Element
X-Ref:
- Ast Flat File Format Node
- Ast File Format Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| CodePage | Int32 | 0 | This value specifies the code page to use for character and string manipulation of non-Unicode text. |
| ColumnNamesInFirstDataRow | Boolean | False | This value specifies whether more descriptive column names are provided in the first data row to replace the column names specified in the Flat File Format Columns collection. |
| DataRowsToSkip | Int32 | 0 | This value specifies how many data rows to skip before beginning to product data. |
| FlatFileType | FlatFileType | Delimited | This value specifies the type of the flat file. |
| HeaderRowDelimiter | Delimiter | CRLF | This value specifies the delimiter to use for column header rows. |
| HeaderRowsToSkip | Int32 | 0 | This value specifies how many header rows to skip before reading data rows. |
| IsUnicode | Boolean | True | This value specifies whether Unicode character and string manipulation will be used. |
| Locale | Language | None | This value specifies the locale, which applies language-specific ordering and date and time formats to the data. |
| LogicalDisplayFolder | String | string.Empty | Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio. |
| RowDelimiter | Delimiter | CRLF | This value specifies the delimiter to use to segregate rows. |
| TextQualifier | String | This value specifies which character is used to identify contiguous blocks of text in a flat file. Column delimiters within blocks of contiguous text will be ignored and treated as text data. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |
| <Columns> <Column /> </Columns> | AstFlatFileColumnNode | This is a collection of flat file column definitions that specify the types, names, and other configuration information for the columns contained in the flat file. |