Expands on the functionality of the standard DataGrid control to add data visualization features to your Apache Flex application. These features provide greater control of data display, data aggregation, and data formatting.
The AdvancedDataGrid control is like a List control except that it can show more than one column of data, making it suited for showing objects with multiple properties.
public class FlexAdvancedDataGrid : FlexListBase,
'Declaration Public Class FlexAdvancedDataGrid _ Inherits FlexListBase
| Name | Description |
|---|---|
| allowDragSelection | whether drag-selection is enabled. Drag-Selection is the ability to select an item by dragging into it as opposed to normal selection where you can't have the mouse button down when you mouse over the item you want to select. |
| allowMultipleSelection | whether you can allow more than one item to be selected at the same time. (Inherited from FlexListBase) |
| alpha | the alpha transparency value of the object specified. (Inherited from FlexDisplayObject) |
| alternatingItemColors | the colors to use for the backgrounds of the items in the list. (Inherited from FlexListBase) |
| automationClassName | a string containing the automation class name for the element. (Inherited from FlexObject) |
| automationIndex | a string containing the automation index for the element. (Inherited from FlexObject) |
| automationName | the name that can be used as an identifier for this object. (Inherited from FlexObject) |
| backgroundDisabledColor | the color of text in the component if it is disabled. The default value is 0xAAB3B3. (Inherited from FlexListBase) |
| className | the name of this instance's class, such as Button. (Inherited from FlexObject) |
| columnCount | the number of columns to be displayed in a TileList control or items in a HorizontalList control. (Inherited from FlexListBase) |
| columnNames | a list containing the names of all columns in the data. (Inherited from FlexListBase) |
| columnWidth | the width of the control's columns. (Inherited from FlexListBase) |
| currentState | the current view state of the component. (Inherited from FlexObject) |
| dataTipField | the name of the field in the data provider items to display as the data tip. (Inherited from FlexListBase) |
| depthColors | the array of colors used for the rows of each level of the navigation tree of the AdvancedDataGrid control, in descending order. The default value is undefined. |
| disabledColor | the color of text in the component if it is disabled. |
| displayItemsExpanded | whether the navigation tree is expanded to show all items. |
| editable | whether the user can edit items in the data provider. |
| enabled | whether the component can accept user interaction. (Inherited from FlexObject) |
| errorColor | the color of the component highlight when validation fails. (Inherited from FlexObject) |
| errorString | the text that will be displayed by a component's error tip when a component is monitored and validation fails. (Inherited from FlexObject) |
| firstVisibleRow | the index of the first visible child. (Inherited from FlexListBase) |
| focusAlpha | the alpha transparency value of the focus skin. The default value is 0.4. (Inherited from FlexListBase) |
| focusEnabled | whether the component can receive focus when tabbed to. (Inherited from FlexObject) |
| headerColors | an array of two colors used to draw the header background gradient. |
| headerHeight | the height of the header cell of the column, in pixels. |
| height | the height of the display object, in pixels. (Inherited from FlexDisplayObject) |
| horizontalGridLineColor | the color of the horizontal grid lines. |
| iconField | the name of the field in the data provider object that determines what to display as the icon. (Inherited from FlexListBase) |
| id | the ID of the component. (Inherited from FlexObject) |
| indentation | the indentation for each node of the navigation tree, in pixels. The default value is 17. |
| labelField | the name of the field in the data provider items to display as the label. (Inherited from FlexListBase) |
| lastVisibleRow | the index of the last visible child. (Inherited from FlexListBase) |
| lockedColumnCount | the index of the first column in the control that scrolls. (Inherited from FlexListBase) |
| lockedRowCount | the index of the first row in the control that scrolls. (Inherited from FlexListBase) |
| minColumnWidth | the minimum width of the columns, in pixels. |
| mouseEnabled | whether this object receives mouse messages. The default value is true, which means that by default any InteractiveObject instance that is on the display list receives mouse events. If mouseEnabled is set to false, the instance does not receive any mouse events. Any children of this instance on the display list are not affected. To change the mouseEnabled behavior for all children of an object on the display list, use flash.display.DisplayObjectContainer.mouseChildren. (Inherited from FlexDisplayObject) |
| numAutomationChildren | the number of automation children this container has. (Inherited from FlexObject) |
| numColumns | the total number of columns in the data available. (Inherited from FlexListBase) |
| numRows | the total number of rows of data available. (Inherited from FlexListBase) |
| openDuration | the length of an open or close transition for the navigation tree, in milliseconds. The default value is 250. |
| paddingBottom | the number of pixels between the bottom of the row and the bottom of the renderer in the row. |
| paddingLeft | the number of pixels between the control's left border and the left edge of its content area. The default value is 2. |
| paddingRight | the number of pixels between the control's right border and the right edge of its content area. The default value is 0. |
| paddingTop | the number of pixels between the top of the row and the top of the renderer in the row. |
| percentHeight | the number that specifies the height of a component as a percentage of its parent's size. (Inherited from FlexObject) |
| percentWidth | the number that specifies the width of a component as a percentage of its parent's size. Allowed values are 0-100. The default value is NaN. Setting the width or explicitWidth properties resets this property to NaN. (Inherited from FlexObject) |
| resizableColumns | whether the user can change the size of the columns. |
| rollOverColor | the color of the background of a renderer when the user rolls over it. The default value is 0xEEFEE6. (Inherited from FlexListBase) |
| rowCount | the number of rows to be displayed. (Inherited from FlexListBase) |
| rowHeight | the height of the rows in pixels. (Inherited from FlexListBase) |
| scaleX | the number that specifies the horizontal scaling factor. (Inherited from FlexObject) |
| scaleY | the number that specifies the vertical scaling factor. (Inherited from FlexObject) |
| selectable | whether the list shows selected items as selected. (Inherited from FlexListBase) |
| selectedCells | an Array of cell locations as row and column indices. |
| selectedIndex | the index in the data provider of the selected item. (Inherited from FlexListBase) |
| selectedIndices | an array of indices in the data provider of the selected items. (Inherited from FlexListBase) |
| selectedItem | a reference to the selected item in the data provider. (Inherited from FlexListBase) |
| selectedItems | an array of references to the selected items in the data provider. (Inherited from FlexListBase) |
| selectionColor | the color of the background of a renderer when the user selects it. The default value is 0x7FCEFF. (Inherited from FlexListBase) |
| selectionDisabledColor | the color of the background of a renderer when the component is disabled. The default value is 0xDDDDDD. (Inherited from FlexListBase) |
| selectionMode | the selection mode of the control. |
| showDataTips | whether dataTips are displayed for text in the rows. (Inherited from FlexListBase) |
| tabChildren | whether the children of the display object are tab enabled. The default is true. (Inherited from FlexDisplayObject) |
| tabEnabled | whether this object is in the tab order. (Inherited from FlexDisplayObject) |
| tabIndex | the tab ordering of objects in a SWF file. (Inherited from FlexDisplayObject) |
| Text | The text of the control. (Inherited from TestObject) |
| textRollOverColor | the text color of the label as the user moves the mouse pointer over the button. The default value is 0x2B333C. (Inherited from FlexListBase) |
| textSelectedColor | the color of the text of a renderer when the user selects it. The default value is 0x2B333C. (Inherited from FlexListBase) |
| themeColor | the theme color of a component. (Inherited from FlexObject) |
| toolTip | the text to display in the ToolTip. The default value is null (Nothing in Visual Basic). (Inherited from FlexObject) |
| useHandCursor | whether the pointing hand cursor appears when the mouse rolls over an element. The default value is true. If useHandCursor is false, the arrow pointer is used instead. (Inherited from FlexObject) |
| useRollOver | whether items are highlighted as the mouse rolls over them. (Inherited from FlexListBase) |
| Value | The value of the control, e.g.: text in a text control. (Inherited from TestObject) |
| variableRowHeight | whether the individual rows can have different height. (Inherited from FlexListBase) |
| verticalAlign | the vertical alignment of a renderer in a row. (Inherited from FlexListBase) |
| verticalGridLineColor | the color of the vertical grid lines. The default value is 0x666666. |
| visible | whether the display object is visible. (Inherited from FlexDisplayObject) |
| width | the width of the display object, in pixels. (Inherited from FlexDisplayObject) |
| wordWrap | whether text in the row should be word wrapped. (Inherited from FlexListBase) |
| x | the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. (Inherited from FlexDisplayObject) |
| y | the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. (Inherited from FlexDisplayObject) |
| Name | Description |
|---|---|
| CaptureBitmap | Saves a bitmap image of this object to a file. If you do not specify an absolute file name, the bitmap is saved to the default bitmap location on the machine that runs the Agent, which is %LOCALAPPDATA%/Silk/SilkTest/capturedBitmaps. The captured bitmap's pixels are stored in 32bit RGB order; when parsing the image the 4th byte (alpha channel) of every pixel must be ignored as it is used only for padding. In .NET, the constant System.Drawing.Imaging.PixelFormat.Format32bppRgb can be used for this purpose. (Inherited from TestObject) |
| ChangeFocus | Changes the current focus. (Inherited from FlexObject) |
| Click | Clicks on the object. (Inherited from IClickable) |
| Close | Closes or collapses a AdvancedDataGrid branch. |
| ColumnGroupedADGHeaderShift | Dispatched when the user releases the mouse button on a column header after having dragged the column to a new location resulting in shifting the column to a new index. |
| ColumnStretch | Dispatched when a user changes the width of a column, indicating that the amount of data displayed in that column may have changed. |
| Deselect | Defines the value of the type property of the event object for an event that is dispatched when a previously selected item is deselected. (Inherited from FlexListBase) |
| DoubleClick | Double-clicks a mouse button on the object. (Inherited from IClickable) |
| DoubleSelect | Defines the value of the type property of the ListEvent object for an itemDoubleClick event, which indicates that the user double-clicked the mouse over a visual item in the control. (Inherited from FlexListBase) |
| DragCancel | Defines the value of the type property of the event object for a dragComplete event. (Inherited from FlexListBase) |
| DragDrop | Defines the value of the type property of the event object for a dragDrop event. (Inherited from FlexListBase) |
| DragStart | Defines the value of the type property of the event object for a dragStart event. (Inherited from FlexListBase) |
| Exists | Checks if any child object matching the locator exists for an object in the application under test. If the timeout parameter is passed the agent retries finding until the given timeout expires. If no timeout is specified and no object is found initially false is returned immediately. (Inherited from TestObject) |
| Exists | Checks if an object exists in the application under test. (Inherited from TestObject) |
| Find | Finds an object specified by an XPath locator. (Inherited from TestObject) |
| FindAll | Finds all objects specified by an XPath locator. (Inherited from TestObject) |
| GenerateLocator | Returns a locator for this object. (Inherited from TestObject) |
| GetCellData | Returns data for a cell in the grid. |
| GetChildren | Returns the child objects of this object. (Inherited from TestObject) |
| GetDynamicMethodList | Returns a list of methods (including their signature) that can be dynamically invoked on this TestObject. (Inherited from TestObject) |
| GetGroupedItemChildrenCount | Returns the number of children within the first item of a group. |
| GetParent | Looks up the parent of this object in the test application. (Inherited from TestObject) |
| GetProperty | Returns the value of the specified property. (Inherited from TestObject) |
| GetPropertyList | Returns a list of property names that can be retrieved for the given object. (Inherited from TestObject) |
| GetRect | Returns the size and position of this object. Per default the returned coordinates are relative to the parent window that contains this object. (Inherited from TestObject) |
| GetRowData | Returns data for the row of the item in the data provider. |
| GetStyle | Returns the style value for the given style. For available styles consider the Apache Flex sdk documentation. (Inherited from FlexDisplayObject) |
| GetValues | Returns a matrix containing the automation values of all parts of the components. (Inherited from FlexListBase) |
| HeaderClick | Dispatched when the user releases the mouse button on a column header to request the control to sort the grid contents based on the contents of the column. |
| HeaderShift | Dispatched when the user releases the mouse button on a column header after having dragged the column to a new location resulting in shifting the column to a new index. |
| HighlightObject | Highlights this object. (Inherited from TestObject) |
| ImageClick | Clicks on the specified image asset. (Inherited from TestObject) |
| ImageClickFile | Clicks on the specified image. (Inherited from TestObject) |
| ImageExists | Returns whether the specified image asset exists. (Inherited from TestObject) |
| ImageExistsFile | Returns whether the specified image exists. (Inherited from TestObject) |
| ImageRectangle | Returns the object-relative rectangle of the specified image asset. (Inherited from TestObject) |
| ImageRectangleFile | Returns the object-relative rectangle of the specified image. (Inherited from TestObject) |
| Invoke | Dynamically invokes a method on the test object. (Inherited from TestObject) |
| InvokeMethods | Dynamically invokes a sequence of methods starting at this TestObject. (Inherited from TestObject) |
| IsGroupedItem | Returns a value that specifies whether the item is a member of a group. |
| MouseMove | Moves the pointer to the specified location in the object. This method is not supported for mobile Web applications. (Inherited from IClickable) |
| MouseScroll | Dispatched when a mouse wheel is spun over an InteractiveObject instance. (Inherited from FlexScrollBase) |
| Move | Moves the component to a specified position within its parent. Calling this method is the same as setting the component's x and y properties. (Inherited from FlexObject) |
| MultiSelect | Defines the value of the type property of the event object for an event that is dispatched when an item is selected as part of an action that selects multiple items. (Inherited from FlexListBase) |
| Open | Opens or expands an AdvancedDataGrid branch. |
| PressKeys | Presses (but does not release) a set of keys or mouse buttons. (Inherited from IKeyable) |
| PressMouse | Presses (but does not release) a mouse button in the object. This method is not supported for mobile Web applications. (Inherited from IClickable) |
| ReleaseKeys | Releases a set of keys or mouse buttons. (Inherited from IKeyable) |
| ReleaseMouse | Releases a mouse button. This method is not supported for mobile Web applications. (Inherited from IClickable) |
| Scroll | Defines the value of the type property of the event object for a scroll event. (Inherited from FlexListBase) |
| ScrollToIndex | Ensures that the data provider item at the given index is visible. (Inherited from FlexListBase) |
| Select | Defines the value of the type property of the event object for an event that is dispatched when a single item is selected. (Inherited from FlexListBase) |
| SelectIndex | Defines the value of the type property of the event object for an event that is dispatched when a single item is selected. (Inherited from FlexListBase) |
| SetFocus | Sets the focus to this component. The component may in turn pass focus to a subcomponent. (Inherited from FlexObject) |
| SetProperty | Sets the value of the specified property. (Inherited from TestObject) |
| StartScreenRecording | Starts screen recording (Inherited from TestObject) |
| StopScreenRecording | Stops screen recording (Inherited from TestObject) |
| TextCapture | Returns the text in this object's visible area. (Inherited from TestObject) |
| TextClick | Clicks in the center of the specified text. (Inherited from TestObject) |
| TextExists | Returns whether the specified text exists. (Inherited from TestObject) |
| TextRectangle | Returns the object-relative rectangle of the specified text. (Inherited from TestObject) |
| ToString | Returns a string representation of the control. (Inherited from FlexDisplayObject) |
| Type | Dispatched when the user presses a key. (Inherited from FlexListBase) |
| TypeKeys | Sends a set of keystrokes to the object. (Inherited from IKeyable) |
| TypePasswordKeys | Types an encrypted password into an object, for example a text field. (Inherited from IKeyable) |
| Verify | Executes a verification on the given asset in the context of this UI object. (Inherited from TestObject) |
| WaitForChildDisappearance | Waits until the specified child object does not exist or until the timeout is reached. If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject) |
| WaitForDisappearance | Waits until the object does not exist or until the timeout is reached. If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject) |
| WaitForObject | Waits for an object that matches the specified locator. If no object matches within an timeout an ObjectNotFoundException is thrown. The default timeout is 5 seconds and you can change the timeout by setting the value of the option OPT_WAIT_RESOLVE_OBJDEF. Use WaitForObject if the AUT takes a long time to display a specific object, for example when a transaction is processed before showing any results. By default, an action in the UI does not require a WaitForObject, because of the built-in synchronization. If you receive random timeout errors during normal script execution, consider increasing the default timeout instead of adding WaitForObject statements to your scripts. (Inherited from TestObject) |
| WaitForProperty | Waits until the specified property has the specified value or until the timeout is reached.If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject) |
| WaitForPropertyNotEquals | Waits until the specified property has a value that is different to the specified value or until the timeout is reached.If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject) |
| WaitForScreenshotStable | Waits until the control is visually stable and does not change its position, by comparing screenshots taken with the specified interval. If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_SCREENSHOT_STABLE will be used. The default interval is 200 milliseconds. An exception is thrown if the timeout is reached. (Inherited from TestObject) |