Class # iOSMobileTable

forsearch

Listbox

forsearch

Table --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description An iOSMobileTable is used for displaying a list of data. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |-----------------------------------------------------------------|---------------------------------------------------------------|-----------|--------| | `AccessibilityHint` | `String` | | | | `AccessibilityLabel` | `String` | | | | `AllowRefresh` | `Boolean` | | | | `AllowSearch` | `Boolean` | | | | `BackgroundColor` | `ColorGroup` | | | | `ControlCount` | `Integer` | | | | `DataSource` | `iOSMobileTableDataSource` | | | | `EditingEnabled` | `Boolean` | | | | `Enabled` | `Boolean` | | | | `EstimatedRowHeight` | `Integer` | | | | `Format` | `Formats` | ✓ | | | `Height` | `Integer` | ✓ | | | `Left` | `Integer` | ✓ | | | `Name` | `String` | ✓ | | | `Parent` | `MobileUIControl` | ✓ | | | `SectionBackgroundColor` | `ColorGroup` | | | | `SectionCount` | `Integer` | ✓ | | | `SectionTextColor` | `ColorGroup` | | | | `SelectedRow` | `Pair` | ✓ | | | `SelectedRowColor` | `ColorGroup` | | | | `TintColor` | `ColorGroup` | | | | `Top` | `Integer` | ✓ | | | `Visible` | `Boolean` | | | | `Width` | `Integer` | ✓ | | ## Methods

table-centered_column_4

| Name | Parameters | Returns | Shared | |---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|--------| | `AddConstraint` | constraint As `iOSLayoutConstraint` | | | | `AddControl` | child As `MobileUIControl`, isBeingAdded As `Boolean` = `False` | | | | `AddRow` | section As `Integer`, value As `MobileTableCellData` | | | | | section As `Integer`, value As `String` | | | | | value As `String` | | | | `AddRowAt` | section As `Integer`, index As `Integer` | | | | | section As `Integer`, index As `Integer`, value As `MobileTableCellData` | | | | | section As `Integer`, index As `Integer`, value As `String` | | | | `AddSection` | title As `String` = "" | | | | | title As `String` = "" | `Integer` | | | `AddSectionAt` | index As `Integer` | | | | | index As `Integer`, title As `String` | | | | `ClearFocus` | | | | | `Constructor` | format As `Formats` | | | | `Constraint` | name As `String` | `iOSLayoutConstraint` | | | `ControlAt` | index As `Integer` | `MobileUIControl` | | | `Controls` | | `Iterable` | | | `CreateCell` | value As `String` = "", detail As `String` = "", image As `Picture` = `Nil`, accessory As `AccessoryTypes` = `AccessoryTypes.None` | `MobileTableCellData` | | | `CreateCustomCell` | controlClass As `Introspection.TypeInfo` | `MobileTableCellData` | | | `EndRefresh` | | | | | `Handle` | | `Ptr` | | | `Refresh` | | | | | `ReloadFromDataSource` | | | | | `ReloadRowFromDataSource` | section As `Integer`, row As `Integer` | | | | `ReloadSectionFromDataSource` | section As `Integer` | | | | `RemoveAllRows` | | | | | `RemoveConstraint` | constraint As `iOSLayoutConstraint` | | | | | name As `String` | | | | `RemoveControl` | child As `MobileUIControl` | | | | `RemoveRowAt` | row As `Integer` | | | | | section As `Integer`, row As `Integer` | | | | `RemoveSectionAt` | section As `Integer` | | | | `RowCellData` | row As `Integer` | `MobileTableCellData` | | | | section As `Integer`, row As `Integer` | `MobileTableCellData` | | | `RowCount` | | `Integer` | | | | section As `Integer` | `Integer` | | | `ScrollToRow` | row As `Integer`, animated As `Boolean` = `True`, position As `ScrollPositions` = `ScrollPositions.None` | | | | | section As `Integer`, row As `Integer`, animated As `Boolean` = `True`, position As `ScrollPositions` = `ScrollPositions.None` | | | | `SearchControllerHandle` | | `Ptr` | | | `SectionTitleAt` | section As `Integer` | `String` | | | | section As `Integer`, `Assigns` value As `String` | | | | `SelectRow` | section As `Integer`, row As `Integer` | | | | `SetFocus` | | | | ## Events

table-centered_column_3

| Name | Parameters | Returns | |-----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------| | `AccessoryPressed` | section As `Integer`, row As `Integer` | | | `ApplyActionsForRow` | section As `Integer`, row As `Integer` | `iOSMobileTableRowAction()` | | `ApplyLeadingActionsForRow` | section As `Integer`, row As `Integer` | `iOSMobileTableRowAction()` | | `ApplyRowEditingStyle` | section As `Integer`, row As `Integer` | `RowEditingStyles` | | `Closing` | | | | `Opening` | | | | `Refreshed` | | | | `RowActionSelected` | section As `Integer`, row As `Integer`, actionTag As `Variant` | | | `Scrolled` | x As `Integer`, y As `Integer` | | | `SearchChanged` | value As `String` | | | `SelectionChanged` | section As `Integer`, row As `Integer` | | ## Enumerations

forsearch

iOSMobileTable.Formats ### Formats > Indicates the formatting of the table. Used by the Format property. You can set this value using the Format property in the Inspector. (Plain, Grouped, InsetGrouped) > > | Name | Description | > |--------------|--------------------------------------------------------------------------------------------------------| > | Plain | A plain table consists of just the rows and section headings. This is the default. | > | Grouped | A grouped table has the section headings displayed outside of the table in visually distinct sections. | > | InsetGrouped | A grouped table where the grouped sections are inset with rounded corners. |

forsearch

iOSMobileTable.RowEditingStyles ### RowEditingStyles > The styles available for when a row is being edited. Set the style for specific rows in the RowEditingStyle event handler. (None, Delete, Insert) > > | Name | Description | > |--------|-------------------------------------------------------------------------------------------------------------------------| > | None | The row will have no editing control shown. | > | Delete | The row will have the deletion editing style, indicated with a red minus sign. | > | Insert | The row will have the insertion editing style, indicated with a green plus sign. This is the default for editable rows. |

forsearch

iOSMobileTable.ScrollPositions ### ScrollPositions Indicates the position of the table after scrolling to the section/row. Used by the ScrollToRow method. (None, Top, Middle, Bottom) > | Name | Description | > |--------|-----------------------------------------------------------------------------------------------------------------| > | None | Scrolls the row to be visible. No action is performed if the row is already fully visible. This is the default. | > | Top | Scrolls table so that the row is displayed at the top of the table. | > | Middle | Scrolls table so that the row is displayed in the middle of the table. | > | Bottom | Scrolls table so that the row is displayed at the bottom of the table. | ## Property descriptions

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.AccessibilityHint **AccessibilityHint** As `String` > The accessibility hint is a longer description that is read aloud when VoiceOver is enabled. > > ``` xojo > Me.AccessibilityHint = "Click to calculate the value and display the next screen." > ```

forsearch

iOSMobileTable.AccessibilityLabel **AccessibilityLabel** As `String` > The accessibility label of of a control is a short name that is read aloud when VoiceOver is enabled. > > ``` xojo > Me.AccessibilityLabel = "Calculate the value." > ```

forsearch

iOSMobileTable.AllowRefresh **AllowRefresh** As `Boolean` > Enables iOS pull-to-refresh feature when `True`. When the user initiates the pull-to-refresh action, the `Refreshed` event is called. When done refreshing data, call the `EndRefresh` method.

forsearch

iOSMobileTable.AllowSearch **AllowSearch** As `Boolean` > Adds a search field to the table. Pull down on the table at runtime to display the search field.

forsearch

iOSMobileTable.BackgroundColor **BackgroundColor** As `ColorGroup` > The background color for the iOSMobileTable. > > This code sets the value of the BackgroundColor property: > > ``` xojo > Me.BackgroundColor = Color.LightGray > ```

forsearch

iOSMobileTable.ControlCount **ControlCount** As `Integer` > The number of child controls in the control.

forsearch

iOSMobileTable.DataSource **DataSource** As `iOSMobileTableDataSource` > The data to display in the table. > > For data sets that are large, a data source allows you to efficiently provide rows without the memory cost of having an `MobileTableCellData` in memory at all times for every single one of them. > > DataSource is a weak reference so you need to make sure your data source instance does not go out of scope. The easiest way to ensure this is to make it a property of your `MobileScreen`.

forsearch

iOSMobileTable.EditingEnabled **EditingEnabled** As `Boolean` > Determines if the table is currently being edited by the user. Animations are performed when this value is changed.

forsearch

iOSMobileTable.Enabled **Enabled** As `Boolean` > Indicates whether the control is enabled or disabled. > > Disable the button: > > ``` xojo > Button1.Enabled = False > ```

forsearch

iOSMobileTable.EstimatedRowHeight **EstimatedRowHeight** As `Integer` > For use with custom table cells, this allows you to specify an estimated row height to help with the drawing of the rows and determine what needs scrolling. > > With custom table cells, the table doesn't know in advance what the cells will be or how high they'll be. Using the estimated row height allows the table to determine how high its content is (and how much scrolling needs to happen) without instantiating every single cell that the table contains. > > For non-custom cells, you should leave this as 0 and the framework will do the right thing. When you set the estimated row height, it's important to get it somewhat accurate (e.g. being 10% off probably won't matter, being 100% off causes bugs).

forsearch

iOSMobileTable.Format **Format** As `Formats` > The format type for the table. This can only be specified at design-time in the Inspector. The default is `iOSMobileTable`.Plain. > > This property is read-only.

forsearch

iOSMobileTable.Height **Height** As `Integer` > The height of the control. > > This property is read-only.

forsearch

iOSMobileTable.Left **Left** As `Integer` > The left position of the control. > > This property is read-only.

forsearch

iOSMobileTable.Name **Name** As `String` > The name of the control. > > This property is read-only.

forsearch

iOSMobileTable.Parent **Parent** As `MobileUIControl` > The parent (sometimes called a "Super") class of the control. > > This property is read-only.

forsearch

iOSMobileTable.SectionBackgroundColor **SectionBackgroundColor** As `ColorGroup` > The background color for sections of the iOSMobileTable. > > This code sets the value of the SectionBackgroundColor property: > > ``` xojo > Me.SectionBackgroundColor = Color.Yellow > ```

forsearch

iOSMobileTable.SectionCount **SectionCount** As `Integer` > The count of sections in the table. > > This property is read-only. > > Get the number of sections in the table: > > ``` xojo > Var sections As Integer = Table1.SectionCount > ```

forsearch

iOSMobileTable.SectionTextColor **SectionTextColor** As `ColorGroup` > The text color for sections of the iOSMobileTable. > > This code sets the value of the SectionTextColor property: > > ``` xojo > Me.SectionTextColor = Color.Red > ```

forsearch

iOSMobileTable.SelectedRow **SelectedRow** As `Pair` > Returns the selected section and row via a `Pair`. > > This property is read-only. > > ``` xojo > Var selection As Pair = Table1.SelectedRow > Var section, row As Integer > section = selection.Left > row = selection.Right > ```

forsearch

iOSMobileTable.SelectedRowColor **SelectedRowColor** As `ColorGroup` > The color used to draw the background of a row when selected. > > From the `Opening` event, set the SelectedRowColor property to blue: > > ``` xojo > Me.SelectedRowColor = Color.Blue > ```

forsearch

iOSMobileTable.TintColor **TintColor** As `ColorGroup` > Changes a control's tint color. > > On iOS, the following controls support TintColor: > > | Enum | Description | > |-------------|------------------------------------------------------------------------------| > | PopupMenu | The background color will be drawn in the TintColor. | > | ProgressBar | The area indicating the value of the control will be drawn in the TintColor. | > | Slider | The area indicating the value of the control will be drawn in the TintColor. | > | Switch | The background of the color will be drawn in the TintColor. | > | TextArea | The cursor and text highlight color will be drawn in the TintColor. | > | TextField | The cursor and text highlight color will be drawn in the TintColor. |

forsearch

iOSMobileTable.Top **Top** As `Integer` > The top position of the control. > > This property is read-only.

forsearch

iOSMobileTable.Visible **Visible** As `Boolean` > Indicates whether the control is visible. > > Make a button invisible: > > ``` xojo > Button1.Visible = False > ```

forsearch

iOSMobileTable.Width **Width** As `Integer` > The width of the control. > > This property is read-only. ## Method descriptions

forsearch

iOSMobileTable.AddConstraint **AddConstraint**(constraint As `iOSLayoutConstraint`, name As `String` = "") > Adds a *constraint* to the control. The optional *name* parameter can be used to `remove a constraint` that was added via code. > > This *constraint* is used by child controls that have been added to this control.

forsearch

iOSMobileTable.AddControl **AddControl**(child As `MobileUIControl`, isBeingAdded As `Boolean` = `False`) > Adds a *child* control to the control. When the value of *isBeingAdded* is `True`, the Opening event is triggered for the child control being added.

forsearch

iOSMobileTable.AddRow **AddRow**(section As `Integer`, value As `MobileTableCellData`) > Adds a new row with the value fetched from the DataSource. This method only works when the table has a DataSource specified. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.AddRow **AddRow**(section As `Integer`, value As `String`) > Adds a new row with the *value* passed. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.AddRow **AddRow**(value As `String`) > Adds a new row with the *value* passed. > > If you are adding many rows, you should instead use `iOSMobileTableDataSource` for better performance and reduced memory usage. > > The following exceptions can be raised: > > | Exception | Description | > |--------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------| > | `OutOfBoundsException` | When the section does not exist. At least one section must be added to the table before adding rows. | > | `UnsupportedOperationException` | When the table has a DataSource specified. | > > Adds five rows to a table: > > ``` xojo > For i As Integer = 0 To 4 > Table1.AddRow(0, "Row " + i.ToString) > Next > ``` > > Adds five rows to a table using a cell: > > ``` xojo > Var cell As MobileTableCellData > > For i As Integer = 0 To 4 > cell = Table1.CreateCell("Row " + i.ToString) > Table1.AddRow(0, cell) > Next > ```

forsearch

iOSMobileTable.AddRowAt **AddRowAt**(section As `Integer`, index As `Integer`) > Adds a new row for the *section* at the row *index*. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.AddRowAt **AddRowAt**(section As `Integer`, index As `Integer`, value As `MobileTableCellData`) > When you insert the row using this version of the method, its value is fetched from the DataSource. This method only works when the table has a DataSource specified. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.AddRowAt **AddRowAt**(section As `Integer`, index As `Integer`, value As `String`) > Adds a new row with the *value* for the *section* at the row *index*. > > Adds a row at the beginning of the table, retrieving its value from the specified DataSource: > > ``` xojo > Table1.AddRowAt(0, 0) > ``` > > Inserts a row in the first section: > > ``` xojo > Var cell As New MobileTableCellData > cell.Text = "Hello" > Table1.AddRowAt(0, 0, cell) > ``` > > Add a row in the first position of the Table: > > ``` xojo > Table1.AddRowAt(0, 0, "First Row") > ```

forsearch

iOSMobileTable.AddSection **AddSection**(title As `String` = "") > Adds a section, with the optional *title*, to the table returning the index number for the new section. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.AddSection **AddSection**(title As `String` = "") As `Integer` > Adds a section, with the optional *title*, to the table returning the index number for the new section. > > For a Plain table format, section headings appear in the table itself. Only non-blank section titles appear. If you add a section with a blank title, you cannot change the title later. > > For a Group table format, the sections appear outside of the table. > >

> >

> > Warning > >

> > If an `iOSMobileTableDataSource` is assigned, sections cannot be added because the `iOSMobileTableDataSource` is responsible for that. If you try to add a section when a DataSource has been assigned, an `UnsupportedOperationException` will be raised. > >

> > Add a section called "Tasks": > > ``` xojo > Table1.AddSection("Tasks") > ``` > > You may want to add a section and save the returned section number so you can use it to subsequently add rows: > > ``` xojo > Var newSection As Integer = Table1.AddSection("Tasks") > Table1.AddRow(newSection, "Task 1") > Table1.AddRow(newSection, "Task 2") > ```

forsearch

iOSMobileTable.AddSectionAt **AddSectionAt**(index As `Integer`) > Adds the section title at the specified *index*. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.AddSectionAt **AddSectionAt**(index As `Integer`, title As `String`) > Adds the section *title* at the specified *index*. > > When you insert a section using this method, its value is fetched from the DataSource. This method only works when the table has a DataSource specified. It does nothing when the table does not have a DataSource. > > Adds a row in the first position of the table, retrieving its value from the specified DataSource: > > ``` xojo > Table1.AddRowAt(0) > ``` > > Inserts a section at the top of the table: > > ``` xojo > Table1.AddSectionAt(0, "First!") > ```

forsearch

iOSMobileTable.ClearFocus **ClearFocus** > Removes the focus from the control. > > ``` xojo > TextField1.ClearFocus > ```

forsearch

iOSMobileTable.Constraint **Constraint**(name As `String`) As `iOSLayoutConstraint` > Gets a reference to a named constraint so that you can modify its settings in code. > > Change an existing (and named) constraint of a control on the Screen: > > ``` xojo > ' "TAWidth" is a width constraint for a TextField that has been given > ' a name in the auto-layout Inspector properties. > Var c As iOSLayoutConstraint = Self.Constraint("TAWidth") > c.Offset = 200 > ```

forsearch

iOSMobileTable.Constructor **Constructor**(format As `Formats`) >

> >

> > Note > >

> > `Constructors` are special methods called when you create an object with the `New` keyword and pass in the parameters above. > >

> > Creates a table with the specified *format*.

forsearch

iOSMobileTable.ControlAt **ControlAt**(index As `Integer`) As `MobileUIControl` > Gets the child control at the specified *index*.

forsearch

iOSMobileTable.Controls **Controls** As `Iterable` > Allows you to iterate through all the controls that have been added to this control.

forsearch

iOSMobileTable.CreateCell **CreateCell**(value As `String` = "", detail As `String` = "", image As `Picture` = `Nil`, accessory As `AccessoryTypes` = `AccessoryTypes.None`) As `MobileTableCellData` > Creates a standard table cell, optionally pre-populating its properties with the specified arguments. > > Use this method in place of the `MobileTableCellData` Constructor that was available in versions prior to 2016r2. > > Create a new cell and add it to a table: > > ``` xojo > Var cell As MobileTableCellData > cell = Table1.CreateCell("Red Sox", "MLB", redSoxLogo, MobileTableCellData.AccessoryTypes.Detail) > Table1.AddRow(0, cell) > ```

forsearch

iOSMobileTable.CreateCustomCell **CreateCustomCell**(controlClass As `Introspection.TypeInfo`) As `MobileTableCellData` > Creates or reuses a table cell that uses a custom control that is based on `MobileTableCustomCell`. If there is no view to reuse, the cell's control will be instantiated from the passed type information. > > This is also usable by applications that use AddRow instead of data sources with the caveat that no reuse is possible. This is not recommended for performance reasons and users needing more than a screen's worth of rows should use a data source. If the number of rows with custom controls exceeds a certain threshold the framework will log a message in the debugger to advise users of the situation. > >

> >

> > Warning > >

> > A `NilObjectException` will be raised if the *controlClass* is `Nil`. > >

> >

> > Warning > >

> > An `InvalidArgumentException` will be raised if the *controlClass* is not referring to a class, the *controlClass* refers to a class that has no default constructor or if the *controlClass* does not inherit from `MobileUIControl`. > >

> > *MyTableCell* is a subclass of `MobileTableCustomCell` that contains several controls, including a label called *NameLabel*. This code adds *MyTableCell* as a custom cell in the table and is in the RowData method of class that implements `iOSMobileTableDataSource`: > > ``` xojo > Var cell As MobileTableCellData = table.CreateCustomCell(GetTypeInfo(MyTableCell)) > Var container As MyTableCell = MyTableCell(cell.Control) > container.NameLabel.Text = "Some Text" > Return cell > ``` > > This code directly adds *MyTableCell* as a custom cell to a table using the AddRow method: > > ``` xojo > Var cell As MobileTableCellData = Table1.CreateCustomCell(GetTypeInfo(MyTableCell)) > Var container As MyTableCell = MyTableCell(cell.Control) > container.NameLabel.Text = "Some Text" > Table1.AddRow(0, cell) > ```

forsearch

iOSMobileTable.EndRefresh **EndRefresh** > Call this method when you have finished updating data (in the `Refreshed` event) to close the pull-to-refresh UI.

forsearch

iOSMobileTable.Handle **Handle** As `Ptr` > The handle to the underlying native OS control.

forsearch

iOSMobileTable.Refresh **Refresh** > Marks the control so that it will be redrawn during the next event loop. > > Call Refresh to force a Canvas to redraw itself: > > ``` xojo > Canvas1.Refresh > ```

forsearch

iOSMobileTable.ReloadFromDataSource **ReloadFromDataSource** > Reloads all the table data from the DataSource. > > It is faster to only reload the specific data that need to be refreshed, so consider using `ReloadSectionFromDataSource` or `ReloadRowFromDataSource` instead.

forsearch

iOSMobileTable.ReloadRowFromDataSource **ReloadRowFromDataSource**(section As `Integer`, row As `Integer`) > Reloads the table data for the *section* and *row*. > > Use this method to reload a single cell row after changes have been made to its data (either from a DataSource or by changing the RowData). > > In the `SelectionChanged` event handler, reload the cell row after changing its AccessoryType: > > ``` xojo > Var cell As MobileTableCellData = Me.RowData(section, row) > cell.AccessoryType = MobileTableCellData.AccessoryTypes.Checkmark > Me.ReloadRowFromDataSource(section, row) > ```

forsearch

iOSMobileTable.ReloadSectionFromDataSource **ReloadSectionFromDataSource**(section As `Integer`) > Reloads the table data for the *section*. > > Use this method to reload a section after changes have been made to its data (either from a DataSource or by changing the RowData). > > Reload all the data in section from the related DataSource: > > ``` xojo > Table1.ReloadSectionFromDataSource(0) > ```

forsearch

iOSMobileTable.RemoveAllRows **RemoveAllRows** > Removes all rows from the table. > > Remove all rows: > > ``` xojo > Table1.RemoveAllRows > ```

forsearch

iOSMobileTable.RemoveConstraint **RemoveConstraint**(constraint As `iOSLayoutConstraint`) > Removes a *constraint* from the control. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **RemoveConstraint**(name As `String`) > Removes the constraint with the *name* passed from the `Screen`.

forsearch

iOSMobileTable.RemoveControl **RemoveControl**(child As `MobileUIControl`) > Removes the control from the control.

forsearch

iOSMobileTable.RemoveRowAt **RemoveRowAt**(row As `Integer`) > Removes the *row* from the table. > > Removes row 2: > > ``` xojo > Table1.RemoveRowAt(2) > ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **RemoveRowAt**(section As `Integer`, row As `Integer`) > Removes the *row* from the *section*. > > Removes row 4 from section 0: > > ``` xojo > Table1.RemoveRowAt(0, 4) > ```

forsearch

iOSMobileTable.RemoveSectionAt **RemoveSectionAt**(section As `Integer`) > Removes the *section* from the table (and all its rows). > > Remove section 0 and all the rows it contains: > > ``` xojo > Table1.RemoveSectionAt(0) > ```

forsearch

iOSMobileTable.RowCellData **RowCellData**(row As `Integer`) As `MobileTableCellData` > Returns the cell data for the *row*. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.RowCellData **RowCellData**(section As `Integer`, row As `Integer`) As `MobileTableCellData` > Returns the cell data for the *section* and *row*. > > You can use this method to get at the cell data to change its contents. After changing the contents, call ReloadRowFromDataSource to display the new information. > >

> >

> > Warning > >

> > If the section and/or row does not exist, an OutOfBoundsException will be raised. > >

> > Get all the cell data for the first row in the table and change its text: > > ``` xojo > Var cell As MobileTableCellData > cell = Table1.RowCellData(0, 0) > cell.Text = "Changed" > Table1.ReloadRowFromDataSource(0, 0) > ```

forsearch

iOSMobileTable.RowCount **RowCount** As `Integer` > The count of rows. > > Get the counts of rows in Table1: > > ``` xojo > Var rowCount As Integer > rowCount = Table1.RowCount > ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **RowCount**(section As `Integer`) As `Integer` > The count of rows in a *section*. > > Get the counts of rows in section 0: > > ``` xojo > Var rowCount As Integer > rowCount = Table1.RowCount(0) > ```

forsearch

iOSMobileTable.ScrollToRow **ScrollToRow**(row As `Integer`, animated As `Boolean` = `True`, position As `ScrollPositions` = `ScrollPositions.None`) > Scrolls the table so that the requested *row* is visible. The row's position when scrolling is finished is controlled by the position parameter. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.ScrollToRow **ScrollToRow**(section As `Integer`, row As `Integer`, animated As `Boolean` = `True`, position As `ScrollPositions` = `ScrollPositions.None`) > Scrolls the table so that the requested *row* is visible. The row's position when scrolling is finished is controlled by the position parameter. > > Scroll to section 2, row 10: > > ``` xojo > myTable.ScrollToRow(2, 10) > myTable.ScrollToRow(2, 10, True, Table.ScrollPositions.Middle) > ```

forsearch

iOSMobileTable.SearchControllerHandle **SearchControllerHandle** As `Ptr` > Returns a Ptr to the search controller for use with Declares.

forsearch

iOSMobileTable.SectionTitleAt **SectionTitleAt**(section As `Integer`) As `String` > Gets the title for the *section*. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

iOSMobileTable.SectionTitleAt **SectionTitleAt**(section As `Integer`, `Assigns` value As `String`) > Sets the title for the *section*. > > You cannot change the title section that was originally given a blank title. > > The following exception can be raised: > > | Exception | Description | > |--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| > | `OutOfBoundsException` | When the section does not exist. At least one section must be added to the table before getting or setting its title. | > > Change the first section title: > > ``` xojo > Table1.SectionTitleAt(0) = "New Title" > ``` > > Get the title of the 2nd section: > > ``` xojo > Var title As String = Table1.SectionTitleAt(1) > ```

forsearch

iOSMobileTable.SelectRow **SelectRow**(section As `Integer`, row As `Integer`) > Selects the *row* in *section* passed. > > Select the first row in the first section: > > ``` xojo > Table1.SelectRow(0,0) > ```

forsearch

iOSMobileTable.SetFocus **SetFocus** > Sets the focus to the control. > > ``` xojo > TextField1.SetFocus > ``` ## Event descriptions

forsearch

iOSMobileTable.AccessoryPressed **AccessoryPressed**(section As `Integer`, row As `Integer`) > Called when the accessory (currently only Detail) for a *row* is tapped. > > Get the row's cell data when the accessory it tapped: > > ``` xojo > Var cell As MobileTableCellData = Me.RowCellData(section, row) > ```

forsearch

iOSMobileTable.ApplyActionsForRow **ApplyActionsForRow**(section As `Integer`, row As `Integer`) As `iOSMobileTableRowAction()` > Use this event to specify the actions that can be performed for the given *section* and *row* when the user swipes from right to left. > > Returns an array of `iOSMobileTableRowActions` that will be available for the *section* and *row*. > > Multiple actions are supported. Add each action to the array that is returned from the event. > > Row actions only work for tables that use iOSMobileTableDataSourceEditing and where its RowIsEditable method returns `True`. > > Adds two actions to every row in the table: > > ``` xojo > Var actions(1) As iOSMobileTableRowAction > ' Create the More button > actions(0) = New iOSMobileTableRowAction(iOSMobileTableRowAction.Styles.Normal, "More...", "More") > ' Create the Delete button > actions(1) = New iOSMobileTableRowAction(iOSMobileTableRowAction.Styles.Destructive, "Delete", "Delete") > Return actions > ```

forsearch

iOSMobileTable.ApplyLeadingActionsForRow **ApplyLeadingActionsForRow**(section As `Integer`, row As `Integer`) As `iOSMobileTableRowAction()` > Use this event to specify the actions that can be performed for the given *section* and *row* when the user swipes from left to right. > > Returns an array of `iOSMobileTableRowActions` that will be available for the *section* and *row*. > > Multiple actions are supported. Add each action to the array that is returned from the event. > > Row actions only work for tables that use iOSMobileTableDataSourceEditing and where its RowIsEditable method returns `True`. > > Adds two actions to every row in the table: > > ``` xojo > Var actions(1) As iOSMobileTableRowAction > ' Create the More button > actions(0) = New iOSMobileTableRowAction(iOSMobileTableRowAction.Styles.Normal, "More...", "More") > ' Create the Delete button > actions(1) = New iOSMobileTableRowAction(iOSMobileTableRowAction.Styles.Destructive, "Delete", "Delete") > Return actions > ```

forsearch

iOSMobileTable.ApplyRowEditingStyle **ApplyRowEditingStyle**(section As `Integer`, row As `Integer`) As `RowEditingStyles` > Allows the table to indicate what the editing style should be for a *row*. > > This is invoked if all of the following are met: > > - The table is being edited (IsEditing = True). > - The table is using a custom data source with iOSMobileTableDataSource. > - The custom data source implements iOSMobileTableDataSourceEditing interface. > - The custom data source returns True from RowIsEditable for the section and row. > > If this event is not implemented, the default value is `RowEditingStyles.Delete`.

forsearch

iOSMobileTable.Closing **Closing** > Called when the control's layout is closing.

forsearch

iOSMobileTable.Opening **Opening** > Called when the control's layout is opening. > > This is where you typically put initialization code. > > This example in the Opening event of a label sets its text to "Hello": > > ``` xojo > Me.Text = "Hello" > ```

forsearch

iOSMobileTable.Refreshed **Refreshed** > Called when `AllowRefresh` is `True` and the user has "pulled" to refresh the table. > > Do not call your code to refresh the data here. Call the `EndRefresh` method when finished to close the pull-to-refresh UI.

forsearch

iOSMobileTable.RowActionSelected **RowActionSelected**(section As `Integer`, row As `Integer`, actionTag As `Variant`) > A *row* action has been selected by the user. > > Use the *actionTag* parameter to identify the action that was used. > > Row actions only work for tables that use `iOSMobileTableDataSourceEditing` and where its `AllowRowEditing` method returns `True`. > > Check the actionTag parameter: > > ``` xojo > Select Case actionTag > Case "More" > ' ... show more info > Case "Delete" > ' ... delete something > End Select > ```

forsearch

iOSMobileTable.Scrolled **Scrolled**(x As `Integer`, y As `Integer`) > The iOSMobileTable has been scrolled to *x* and *y*.

forsearch

iOSMobileTable.SearchChanged **SearchChanged**(value As `String`) > The *value* of the table's search field was changed.

forsearch

iOSMobileTable.SelectionChanged **SelectionChanged**(section As `Integer`, row As `Integer`) > A *row* has been selected. > > Get the selected row: > > ``` xojo > Var selectedCell As MobileTableCellData = Me.RowCellData(section, row) > ``` ## Notes An iOSMobileTable has only a single column of cells so by default it can only show one column of data. Use `MobileTableCustomCell` to create your own cells with your own cell layout. This allows you to have a cell with its own controls or even multiple columns. A table can have data added to it in one of two ways: manually or from a data source. Some methods only work with data that was added manually, some methods only work with data added using a data source. If you are adding many rows (100+), you should instead use an `iOSMobileTableDataSource` for better performance and reduced memory usage. A table must have at least one section (0-based). If there is only one section, then the section title does not appear in the table. ## Sample code Add five rows to a table: ``` xojo ' Simple usage For i As Integer = 0 To 4 Table1.AddRow(0, "Row " + i.ToString) Next ``` ## Compatibility | | | |-----------------------|--------| | **Project Types** | Mobile | | **Operating Systems** | iOS |

`MobileUIControl` parent class; `MobileTableCustomCell` control; `MobileTableCellData`, `iOSMobileTableRowAction` classes; `iOSMobileTableDataSource`, `iOSMobileTableDataSourceEditing`, `iOSMobileTableDataSourceReordering`, `iOSMobileTableDataSourceIndex` interfaces