Returns true when some methods on some Atoll interfaces may display some dialogue boxes.
Parameters
[out] pVal: Address of the VARIANT_BOOL used to return whether some dialogue boxe may be displayed upon invokation of some method on some Atoll interface.
Remarks
Setting the Application Object visibility state to false sets this value to false.
HRESULT RunEx(VARIANT_BOOL aAll, VARIANT_BOOL vbBlocking);
HRESULT get_DatabaseSchemaString(BSTR *pVal);
Atoll 3.3.2 Task Automation Guide
Chapter 5: Document Object © 2016 Forsk. All Rights Reserved.
5.48 put_DisplayApplicationDialogues
Returns true when some methods on some Atoll interfaces may display some dialogue boxes.
Parameters
[in] aNewVal: The VARIANT_BOOL used to specify whether some dialogue boxe may be displayed upon invokation of some method on some Atoll interface.
Remarks
Setting the Application Object visibility state to false sets this value to false.
5.49 PutDatabaseSchemaString
Sets the database schema string.
Remarks
This method is not implemented. Please do not use this method.
Atoll Version
2.8.1
5.50 PutDatabaseConnectionString
Sets the database connection string.
Parameters
[in] aVal:
The BSTR used to specify the new database connection string.
To disconnect the document from the database, specify a NULL BSTR value or an empty string.
Remarks
An error is returned when the document is not connected to a database.
Depending on the aVal parameter value, the action performed is the same as Database | Connection Properties | Modify, or Database | Connection Properties | Disconnect.
Atoll Version
2.8.1
5.51 ChangeDatabaseConnection
Changes the database connection string.
HRESULT put_DisplayApplicationDialogues(VARIANT_BOOL aNewVal);
HRESULT PutDatabaseSchemaString(BSTR aVal);
HRESULT PutDatabaseConnectionString(BSTR aVal);
Parameters
[in] aCnn:
The BSTR used to specify the new database connection string. [in] aReserved:
A BSTR reserved for a future usage.
Remarks
Please do not use this method. Use PutDatabaseConnectionString instead.
Atoll Version
2.8.1
5.52 get_TemperatureUnit
Returns the display temperature unit.
Parameters
[out] pVal: Address of the AtoTemperatureUnit enumeration value used to return the display temperature unit.
5.53 put_TemperatureUnit
Sets the display temperature unit.
Parameters
[in] aNewVal: The AtoTemperatureUnit enumeration value used to specify the display temperature unit.
5.54 GetDocumentProperties
Returns the document properties.
Parameters
[out] ppProperties: Address of the IPropertyContainer interface pointer used to return the document properties.
Remarks
Please see the SetDocumentProperties documentation for the list of available document properties.
5.55 SetDocumentProperties
Sets the document properties.
HRESULT get_TemperatureUnit(enum AtoTemperatureUnit *pVal);
HRESULT put_TemperatureUnit(enum AtoTemperatureUnit aNewVal);
HRESULT GetDocumentProperties(IPropertyContainer **ppProperties);
Atoll 3.3.2 Task Automation Guide
Chapter 5: Document Object © 2016 Forsk. All Rights Reserved.
Parameters
[in] pProperties: The IPropertyContainer interface pointer used to specify the document properties.
Remarks
Available document properties are:
Name Type PROJECT String DATE String AUTHOR String TITLE String COMMENT String STATUS String LOGO String USER_PROPERTY0 USER_PROPERTY1 USER_PROPERTY2 USER_PROPERTY3 USER_PROPERTY4 USER_PROPERTY5 USER_PROPERTY6 USER_PROPERTY7 USER_PROPERTY8 USER_PROPERTY9 USER_PROPERTY_NAME0 String USER_PROPERTY_NAME1 String USER_PROPERTY_NAME2 String USER_PROPERTY_NAME3 String USER_PROPERTY_NAME4 String USER_PROPERTY_NAME5 String USER_PROPERTY_NAME6 String USER_PROPERTY_NAME7 String USER_PROPERTY_NAME8 String
5.56 get_RadioTableNames
Returns the names of Radio TabularData Objects in the document.
Parameters
[out] pTableNames: Address of the VARIANT used to return the names of radio database tables in the document. The variant returned is an Array of variants, with variants of type String.
5.57 LogMessage
Displays a message in the Atoll event observer window.
Parameters
[in] bstrMsg: The text to display. [in] aLogType:
• atoInfo: An information message is displayed. • atoError: An error message is displayed. • atoWarning: A warning message is displayed.
USER_PROPERTY_NAME9 String
HRESULT get_RadioTableNames(VARIANT* pTableNames);
Atoll 3.3.2 Task Automation Guide
Chapter 6
TabularData
Object
Atoll 3.3.2 Task Automation Guide
6 TabularData Object
The TabularData object provides access to Atoll tables whether an Atoll document is connected to a database or not. It also provides access to other tables which are not database tables, such as PREDICTIONS and ZONES, explained in "Zones and Predictions Tabular Data Objects" on page 99.
The TabularData object provides the following properties and methods:
Access to tabular data in an Atoll document connected to a database
For each database table, access is provided to differences between the content of the database when the data table has been refreshed for the last time and the current table content stored in an Atoll document. These are the differences listed in the Atoll Database Archive dialogue, which can be submitted through an external process using this interface. Access is given the original data as retrieved by the latest refresh operation from the data- base. Access is not given to the current content of the database. Therefore, it is not possi- ble to show or solve conflicts between the data in the Atoll document and the current content of the database.
For a given database table, original data values and row statuses are not stored in the data- base. They are stored in the Atoll document.
Name Description Attributes
get_ColumnCount Returns the number of columns of the TabularData Object. Type: Integer
Access: Read
get_RowCount Returns the number of rows of the TabularData Object Type: Integer
Access: Read
Edit Puts a row into edition mode.
AddNew Adds a new empty row to the TabularData Object. The row
added is put into edition mode.
Update Commits a row changes and puts the row from edition mode
to normal mode.
Delete Deletes a record.
GetValue Returns a value of a column for a given row.
SetValue Sets the value of a column for the row being edited or added.
GetPrimaryKey Returns the value of the primary key for a given row number. FindPrimaryKey Searches the row whose primary key equals the input value
and returns the row number of the row found.
Find Searches a column for a value.
GetFormattedValue Returns a column value formatted as a string.
CancelUpdate Cancels a pending update.
get_ColumnNumber Returns a column number. Type: Integer
Access: Read
get_CanEdit Checks if rows can be modified. Type: Boolean
Access: Read
get_CanAddNew Checks if rows can be added. Type: Boolean
Access: Read
get_CanFilterSort Checks if rows can be filtered or sorted. Type: Boolean
Access: Read
Atoll 3.3.2 Task Automation Guide
Chapter 6: TabularData Object © 2016 Forsk. All Rights Reserved.