Aspose::Cells::ExternalConnections::WebQueryConnection class
Contents
[
Hide
]WebQueryConnection class
Specifies the properties for a web query source. A web query will retrieve data from HTML tables, and can also supply HTTP “Get” parameters to be processed by the web server in generating the HTML by including the parameters and parameter elements.
class WebQueryConnection : public Aspose::Cells::ExternalConnections::ExternalConnection
Methods
| Method | Description |
|---|---|
| ExternalConnection(ExternalConnection_Impl* impl) | Constructs from an implementation object. |
| ExternalConnection(const ExternalConnection& src) | Copy constructor. |
| GetBackgroundRefresh() | Indicates whether the connection can be refreshed in the background (asynchronously). true if preferred usage of the connection is to refresh asynchronously in the background; false if preferred usage of the connection is to refresh synchronously in the foreground. |
| GetConnectionDescription() | Specifies the user description for this connection. |
| GetConnectionId() | Specifies The unique identifier of this connection. |
| GetCredentialsMethodType() | Specifies the authentication method to be used when establishing (or re-establishing) the connection. |
| GetEditWebPage() | The URL of the user-facing web page showing the web query data. This URL is persisted in the case that sourceData=“true” and url has been redirected to reference an XML file. Then the user-facing page can be shown in the UI, and the XML data can be retrieved behind the scenes. |
| GetHtmlFormat() | How to handle formatting from the HTML source when bringing web query data into the worksheet. Relevant when sourceData is True. |
| GetId() | Gets the id of the connection. |
| GetKeepAlive() | True when the spreadsheet application should make efforts to keep the connection open. When false, the application should close the connection after retrieving the information. |
| GetName() | Specifies the name of the connection. Each connection must have a unique name. |
| GetOdcFile() | Specifies the full path to external connection file from which this connection was created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, then the spreadsheet application will try again using information from the external connection file instead of the connection object embedded within the workbook. |
| GetOnlyUseConnectionFile() | Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the odcFile attribute when the connection is refreshed. If false, then the spreadsheet application should follow the procedure indicated by the reconnectionMethod attribute. |
| GetParameters() | Gets ConnectionParameterCollection for an ODBC or web query. |
| GetPost() | Returns or sets the string used with the post method of inputting data into a web server to return data from a web query. |
| GetPowerQueryFormula() | Gets the definition of power query formula. |
| GetReconnectionMethodType() | Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required. |
| GetRefreshInternal() | Specifies the number of minutes between automatic refreshes of the connection. |
| GetRefreshOnLoad() | True if this connection should be refreshed when opening the file; otherwise, false. |
| GetSaveData() | True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false. |
| GetSavePassword() | True if the password is to be saved as part of the connection string; otherwise, False. |
| GetSourceFile() | Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation. |
| GetSSOId() | Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source. |
| GetType() | Gets or Sets the external connection DataSource type. |
| GetUrl() | URL to use to refresh external data. |
| IsConsecutive() | Flag indicating whether consecutive delimiters should be treated as just one delimiter. |
| IsDeleted() | Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false. |
| IsHtmlTables() | Flag indicating whether web queries should only work on HTML tables. |
| IsNew() | True if the connection has not been refreshed for the first time; otherwise, false. This state can happen when the user saves the file before a query has finished returning. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| IsParsePre() | Flag indicating whether data contained within HTML PRE tags in the web page is parsed into columns when you import the page into a query table. |
| IsSameSettings() | Flag indicating whether to parse all tables inside a PRE block with the same width settings as the first row. |
| IsTextDates() | Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates. |
| IsXl2000() | This flag exists for backward compatibility with older existing spreadsheet files, and is set to true if this web query was refreshed in a spreadsheet application newer than or equal to Microsoft Excel 2000. This is an optional attribute that can be ignored. |
| IsXl97() | This flag exists for backward compatibility with older existing spreadsheet files, and is set to true if this web query was created in Microsoft Excel 97. This is an optional attribute that can be ignored. |
| IsXml() | true if the web query source is XML (versus HTML), otherwise false. |
| IsXmlSourceData() | Flag indicating that XML source data should be imported instead of the HTML table itself. |
| explicit operator bool() const | operator bool() |
| operator=(const WebQueryConnection& src) | operator= |
| operator=(const ExternalConnection& src) | operator= |
| SetBackgroundRefresh(bool value) | Indicates whether the connection can be refreshed in the background (asynchronously). true if preferred usage of the connection is to refresh asynchronously in the background; false if preferred usage of the connection is to refresh synchronously in the foreground. |
| SetConnectionDescription(const U16String& value) | Specifies the user description for this connection. |
| SetConnectionDescription(const char16_t* value) | Specifies the user description for this connection. |
| SetCredentialsMethodType(CredentialsMethodType value) | Specifies the authentication method to be used when establishing (or re-establishing) the connection. |
| SetEditWebPage(const U16String& value) | The URL of the user-facing web page showing the web query data. This URL is persisted in the case that sourceData=“true” and url has been redirected to reference an XML file. Then the user-facing page can be shown in the UI, and the XML data can be retrieved behind the scenes. |
| SetEditWebPage(const char16_t* value) | The URL of the user-facing web page showing the web query data. This URL is persisted in the case that sourceData=“true” and url has been redirected to reference an XML file. Then the user-facing page can be shown in the UI, and the XML data can be retrieved behind the scenes. |
| SetHtmlFormat(HtmlFormatHandlingType value) | How to handle formatting from the HTML source when bringing web query data into the worksheet. Relevant when sourceData is True. |
| SetIsConsecutive(bool value) | Flag indicating whether consecutive delimiters should be treated as just one delimiter. |
| SetIsDeleted(bool value) | Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false. |
| SetIsHtmlTables(bool value) | Flag indicating whether web queries should only work on HTML tables. |
| SetIsNew(bool value) | True if the connection has not been refreshed for the first time; otherwise, false. This state can happen when the user saves the file before a query has finished returning. |
| SetIsParsePre(bool value) | Flag indicating whether data contained within HTML PRE tags in the web page is parsed into columns when you import the page into a query table. |
| SetIsSameSettings(bool value) | Flag indicating whether to parse all tables inside a PRE block with the same width settings as the first row. |
| SetIsTextDates(bool value) | Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates. |
| SetIsXl2000(bool value) | This flag exists for backward compatibility with older existing spreadsheet files, and is set to true if this web query was refreshed in a spreadsheet application newer than or equal to Microsoft Excel 2000. This is an optional attribute that can be ignored. |
| SetIsXl97(bool value) | This flag exists for backward compatibility with older existing spreadsheet files, and is set to true if this web query was created in Microsoft Excel 97. This is an optional attribute that can be ignored. |
| SetIsXml(bool value) | true if the web query source is XML (versus HTML), otherwise false. |
| SetIsXmlSourceData(bool value) | Flag indicating that XML source data should be imported instead of the HTML table itself. |
| SetKeepAlive(bool value) | True when the spreadsheet application should make efforts to keep the connection open. When false, the application should close the connection after retrieving the information. |
| SetName(const U16String& value) | Specifies the name of the connection. Each connection must have a unique name. |
| SetName(const char16_t* value) | Specifies the name of the connection. Each connection must have a unique name. |
| SetOdcFile(const U16String& value) | Specifies the full path to external connection file from which this connection was created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, then the spreadsheet application will try again using information from the external connection file instead of the connection object embedded within the workbook. |
| SetOdcFile(const char16_t* value) | Specifies the full path to external connection file from which this connection was created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, then the spreadsheet application will try again using information from the external connection file instead of the connection object embedded within the workbook. |
| SetOnlyUseConnectionFile(bool value) | Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the odcFile attribute when the connection is refreshed. If false, then the spreadsheet application should follow the procedure indicated by the reconnectionMethod attribute. |
| SetPost(const U16String& value) | Returns or sets the string used with the post method of inputting data into a web server to return data from a web query. |
| SetPost(const char16_t* value) | Returns or sets the string used with the post method of inputting data into a web server to return data from a web query. |
| SetReconnectionMethodType(ReConnectionMethodType value) | Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required. |
| SetRefreshInternal(int32_t value) | Specifies the number of minutes between automatic refreshes of the connection. |
| SetRefreshOnLoad(bool value) | True if this connection should be refreshed when opening the file; otherwise, false. |
| SetSaveData(bool value) | True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false. |
| SetSavePassword(bool value) | True if the password is to be saved as part of the connection string; otherwise, False. |
| SetSourceFile(const U16String& value) | Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation. |
| SetSourceFile(const char16_t* value) | Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation. |
| SetSSOId(const U16String& value) | Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source. |
| SetSSOId(const char16_t* value) | Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source. |
| SetType(ConnectionDataSourceType value) | Gets or Sets the external connection DataSource type. |
| SetUrl(const U16String& value) | URL to use to refresh external data. |
| SetUrl(const char16_t* value) | URL to use to refresh external data. |
| WebQueryConnection(WebQueryConnection_Impl* impl) | Constructs from an implementation object. |
| WebQueryConnection(const WebQueryConnection& src) | Copy constructor. |
| WebQueryConnection(const ExternalConnection& src) | Constructs from a parent object. |
| ~ExternalConnection() | Destructor. |
| ~WebQueryConnection() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
See Also
- Class ExternalConnection
- Namespace Aspose::Cells::ExternalConnections
- Library Aspose.Cells for C++