DataGridColumn  - AS3 Flex

与列关联的数据提供程序项目中字段或属性的名称。需要对每个 DataGridColumn 控件设置此属性和/或 labelFunction 属性以计算项呈示器的可显示文本。如果设置了 dataField 和 labelFunction 属性，则使用 labelFunction 显示数据并使用 dataField 对数据排序。如果名为 dataField 的属性不存在，则必须设置 sortCompareFunction 以正确进行排序。

此属性的值不一定是列标题中显示的 String。此属性只用于访问数据提供程序中的数据。有关详细信息，请参阅 headerText 属性。

相关 API 元素

数据提供程序中显示为数据提示的字段名称。默认情况下，DataGrid 控件在每个数据提供程序项目上查找命名为 label 的属性，然后显示该属性。然而，如果数据提供程序不包含 label 属性，您可以设置 dataTipField 属性来指定其他属性。例如，在用户查看数据库中包含的一组用户名时，可以将值设置为“FullName”。

此属性可用作数据绑定的源。修改此属性后，将调度 dataTipFieldChanged 事件。

指定在数据提供程序每个项目上运行的回调函数，以确定其数据提示。此属性由 itemToDataTip 方法使用。

默认情况下，该控件将在每个数据提供程序项目上查找名为 label 的属性，然后将其显示为它的数据提示。不过，某些数据提供程序没有 label 属性或其他可用于显示行中数据的属性。例如，您可能具有包含 lastName 和 firstName 字段的数据提供程序，但您希望将全名显示为数据提示。可以为 dataTipFunction 属性指定一个函数，该函数返回包含这两个字段值的单个 String。还可以使用 dataTipFunction 属性来处理格式和本地化。

此函数必须采用一个 Object 参数（包含数据提供程序元素）并返回一个字符串。

此属性可用作数据绑定的源。修改此属性后，将调度 dataTipFunctionChanged 事件。

一个标志，指示是否允许用户将列拖动到新位置。如果为 true，则用户可以将列标题拖动到新位置

默认值为 true。

指示列中的项目是否可进行编辑的标志。如果为 true，并且 DataGrid 的 editable 属性也为 true，则列中的项目是可编辑的且可以编辑单个项目，具体方法是：单击某个项目或使用 Tab 和箭头键导航到该项目。

默认值为 true。

项目编辑器的属性名称，其中包含列表项目的新数据。例如，默认的 itemEditor 为 TextInput，因此，editorDataField 属性的默认值为 "text"，此值指定 TextInput 控件的 text 属性。

默认值为 "text"。

项目编辑器相对于项呈示器大小的高度（以像素为单位）。使用此属性可以使编辑器与项呈示器产生几个像素的重叠，以补偿编辑器周围的边框。请注意，在显示编辑器时，更改这些值不会对当前编辑器产生任何作用，但会影响下一个打开编辑器的项呈示器。

默认值为 0。

指示项目编辑器是否使用 Enter 键的标志。如果为 true，则项目编辑器将使用 Enter 键，而 DataGrid 不会相应地查找 Enter 键和移动编辑器。请注意，在显示编辑器时，更改此值不会对当前编辑器产生任何作用，但将影响下一个打开编辑器的项呈示器。

默认值为 false.。

项目编辑器相对于项呈示器大小的宽度（以像素为单位）。使用此属性可以使编辑器与项呈示器产生几个像素的重叠，以补偿编辑器周围的边框。请注意，在显示编辑器时，更改这些值不会对当前编辑器产生任何作用，但会影响下一个打开编辑器的项呈示器。

默认值为 0。

项目编辑器左上角相对于项目左上角的 x 位置（以像素为单位）。使用此属性可以使编辑器与项呈示器产生几个像素的重叠，以补偿编辑器周围的边框。请注意，在显示编辑器时，更改这些值不会对当前编辑器产生任何作用，但会影响下一个打开编辑器的项呈示器。

默认值为 0。

项目编辑器左上角相对于项目左上角的 y 位置（以像素为单位）。使用此属性可以使编辑器与项呈示器产生几个像素的重叠，以补偿编辑器周围的边框。请注意，在显示编辑器时，更改这些值不会对当前编辑器产生任何作用，但会影响下一个打开编辑器的项呈示器。

默认值为 0。

一个标志，用于指示当组件获得焦点时是否应启用 IME。如果编辑器已启动，它将相应地设置 enableIME。

显示列标题的项呈示器实例的类工厂。您可以指定嵌入式项呈示器、内嵌项呈示器或自定义项呈示器组件作为此属性的值。

默认项呈示器为 DataGridItemRenderer 类，用于将项目数据显示为文本。

此属性可用作数据绑定的源。修改此属性后，将调度 headerRendererChanged 事件。

此列的标题文本。默认情况下，DataGrid 控件使用 dataField 属性的值作为标题文本。

此属性可用作数据绑定的源。修改此属性后，将调度 headerTextChanged 事件。

一个标志，指示当标题中的文本不能在一行中显示时，是否能够自动换行。如果为 undefined，则使用 DataGrid 控件的 wordWrap 属性。

默认值为 undefined。

指定 IME（输入法编辑器）模式。IME 使用户能够用中文、日文和韩文输入文本。发生 itemFocusIn 事件时，Flex 将设置 IME 模式；发生 itemFocusOut 事件时，将它重新设置回先前的值。flash.system.IMEConversionMode 类定义此属性的有效值的常量。

默认值为空，在这种情况下，它将使用 DataGrid 控件的 imeMode 属性值。

相关 API 元素

列可编辑时，用于列的项目编辑器实例的类工厂。

默认值为 new ClassFactory(mx.controls.TextInput)。

显示列中每个项目数据的项呈示器实例的类工厂。您可以指定嵌入式项呈示器、内嵌项呈示器或自定义项呈示器组件作为此属性的值。

默认项呈示器为 DataGridItemRenderer 类，用于将项目数据显示为文本。

此属性可用作数据绑定的源。修改此属性后，将调度 itemRendererChanged 事件。

确定此列中显示文本的函数。默认情况下，列显示与列名称匹配的数据字段的文本。不过，有时您希望显示基于多个数据字段的文本，或显示不具备自己想要格式的文本。在这种情况下，可使用 labelFunction 指定一个回调函数。

对于 DataGrid 控件，方法签名具有以下格式：

labelFunction(item:Object, column:DataGridColumn):String

其中，item 包含 DataGrid 项目对象，并且 column 指定 DataGrid 列。

回调函数可能会连接数据中的 firstName 和 lastName 字段，或者对 Date 设置某些自定义格式，也可能将月的数字形式转换为字符串形式。

此属性可用作数据绑定的源。修改此属性后，将调度 labelFunctionChanged 事件。

列的最小宽度。

默认值为 20。

此属性可用作数据绑定的源。修改此属性后，将调度 minWidthChanged 事件。

显示列中每个项目数据的项呈示器实例的类工厂。您可以指定嵌入式项呈示器、内嵌项呈示器或自定义项呈示器组件作为此属性的值。

默认项呈示器为 DataGridItemRenderer 类，用于将项目数据显示为文本。

此属性可用作数据绑定的源。修改此属性后，将调度 nullItemRendererChanged 事件。

指示项呈示器也是项目编辑器的标志。如果此属性为 true，则 Flex 将忽略 itemEditor 属性并使用该项目的项呈示器作为编辑器。

默认值为 false。

一个标志，指示是否允许用户调整列的宽度。如果为 true，则用户可以拖动列标题之间的网格线以调整列大小。

默认值为 true。

一个标志，指示是否在列中显示数据提示。如果为 true，则显示行中文本的数据提示。数据提示是一些工具提示，用于显示对行而言过长的文本。

默认值为 false。

一个标志，指示用户是否能够通过单击此列的标题对数据提供程序进行排序。如果此属性和 DataGridsortableColumns 属性均为 true，则当用户在列标题上释放鼠标按键时，DataGrid 控件将调度 headerRelease 事件。如果没有其他处理函数调用 headerRelease 事件的 preventDefault() 方法，则列中的 dataField 属性或 sortCompareFunction 将用于重新排序 dataProvider 中的项目。

默认值为 true。

对列中的数据进行排序时调用的回调函数。如果未指定此属性，则排序将尝试按基本字符串或数字顺序对数据排序。如果数据不是字符串或数字，或者 dataField 属性不是数据提供程序的有效属性，则排序将不起作用或将生成异常。如果指定 labelFunction 属性的值，通常还会为 sortCompareFunction 属性提供一个函数，否则不允许对此列排序。这意味着当列的 dataField 中的值的排序方式与 labelFunction 属性中的计算值的排序方式不相同时指定一个函数。

DataGrid 控件使用此函数对数据提供程序集合的元素排序。回调函数的函数签名采用两个参数并具有以下格式：

mySortCompareFunction(obj1:Object, obj2:Object):int 

obj1 — 要比较的数据元素。

obj2 － 与 obj1 比较的另一个数据元素。

函数应该基于对象比较结果返回值：

• 如果按升序顺序 obj1 应出现在 obj2 前面，则返回 -1。
• 如果 obj1 = obj2，则返回 0。
• 如果按升序顺序 obj1 应出现在 obj2 后面，则返回 1。

注意：obj1 和 obj2 参数是整个数据提供程序元素，而不只是项目数据。

默认值为 null。

此属性可用作数据绑定的源。修改此属性后，将调度 sortCompareFunctionChanged 事件。

指示列排序是按升序排序（设置为 false），还是按 descending 排序（设置为 true）。

设置此属性不会开始进行排序；这只是在设置排序方向。单击列标题执行排序。

默认值为 false;。

一个标志，指示列是否可见。如果为 true，则列可见。

默认值为 true。

列的宽度（以像素为单位）。如果 DataGrid 的 horizontalScrollPolicy 属性为 false，则所有可见列必须适合可显示区域；如果列的总宽度对于可显示区域而言太小或太大，则 DataGrid 将不会始终保持列的宽度。

默认值为 100。

此属性可用作数据绑定的源。修改此属性后，将调度 widthChanged 事件。

一个标志，指示当此列中各行的文本不能在一行中显示时，是否能够自动换行。如果为 undefined，则使用 DataGrid 控件的 wordWrap 属性。

仅当 DataGrid.variableRowHeight 也为 true 时才能生效。

默认值为 undefined。

构造函数。

返回相应的工厂；如果尚未指定，则使用默认工厂。

参数

返回 String，表示项呈示器基于 dataTipField 和 dataTipFunction 属性显示的给定数据对象的数据提示。如果该方法无法将参数转换为字符串，则会返回一个空格。

此方法供创建 DataGridColumn 类的子类的开发人员使用。它不适用于应用程序开发人员。

参数

返回项目渲染器为给定数据对象显示的字符串。如果 DataGridColumn 或其 DataGrid 控件具有非空 labelFunction 属性，则它会将该函数应用于数据对象。否则，此方法会提取由 dataField 属性指定的字段的内容，或者获取数据对象的字符串值。如果该方法无法将参数转换为字符串，则会返回一个空格。

参数