ColumnDefinition
A complex data type that describes a column in a query.
Schema
<xsd:complexType name="ColumnDefinition">
<xsd:sequence>
<xsd:element name="Name" type="xsd:string"/>
<xsd:element name="Description" type="xsd:string"
minOccurs="0"/>
<xsd:element name="DisplayName" type="xsd:string"/>
<xsd:element name="Heading" type="xsd:string" minOccurs="0"/>
<xsd:element name="HelpText" type="xsd:string"
minOccurs="0"/>
<xsd:element name="DataType" type="typens:DataType"
minOccurs="0"/>
<xsd:element name="DisplayLength" type="xsd:long"
minOccurs="0"/>
</xsd:element>
<xsd:element name="DisplayFormat" type="xsd:string" minOccurs="0"/>
</xsd:element>
<xsd:element name="AnalysisType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Automatic"/>
<xsd:enumeration value="Dimension"/>
<xsd:enumeration value="Measure"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="HorizontalAlignment" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Automatic"/>
<xsd:enumeration value="Left"/>
<xsd:enumeration value="Center"/>
<xsd:enumeration value="Right"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="EnableFilter" type="xsd:boolean"/>
<xsd:element name="TextFormat" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Plain" />
<xsd:enumeration value="HTML" />
<xsd:enumeration value="RTF" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Wrap" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="None" />
<xsd:enumeration value="Word" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CategoryPath" type="xsd:string"
minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
Elements
Name
The column name.
Description
The long description of the column.
DisplayName
The display name of the column. If not specified, the value of the Name element is used. If the query is performed on an information object (.iob) or data source map (.sma) file, DisplayName is used as the group label.
Heading
The text to display above the column in the output file.
HelpText
The text to display when the user holds the cursor over a column. For example, a value of a data column.
DataType
The data type of the column.
DisplayLength
The width of the column, in number of characters.
DisplayFormat
The format in which the data of the column appears in the output file.
AnalysisType
Specifies how data in the column is analyzed. One of the following values:
Automatic
Numeric values are analyzed as measures. Non‑numeric values are analyzed as dimensions.
Dimension
Numeric values are analyzed as dimensions.
Measure
Numeric values are analyzed as measures.
HorizontalAlignment
Specifies how data in the column is aligned horizontally. One of the following values:
Automatic
Left
Center
Right
EnableFilter
Specifies whether filtering for the column is enabled. If True, the data in the column can be filtered.
TextFormat
Specifies text formatting. Valid values are:
Plain
HTML
RTF
Wrap
Specifies word wrapping. Valid values are:
None
Word
CategoryPath
The category path for the column.