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.
Inheritance Hierarchy
SystemObject
  Aspose.Cells.ExternalConnectionsExternalConnection
    Aspose.Cells.ExternalConnectionsWebQueryConnection

Namespace: Aspose.Cells.ExternalConnections
Assembly: Aspose.Cells (in Aspose.Cells.dll) Version: 19.11.0.0 (19.11)
Syntax
public class WebQueryConnection : ExternalConnection

The WebQueryConnection type exposes the following members.

Properties
  NameDescription
Public propertyBackgroundRefresh
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.
(Inherited from ExternalConnection.)
Public propertyConnectionDescription
Specifies the user description for this connection
(Inherited from ExternalConnection.)
Public propertyConnectionId
Specifies The unique identifier of this connection.
(Inherited from ExternalConnection.)
Public propertyCredentials Obsolete.
Specifies the authentication method to be used when establishing (or re-establishing) the connection.
(Inherited from ExternalConnection.)
Public propertyCredentialsMethodType
Specifies the authentication method to be used when establishing (or re-establishing) the connection.
(Inherited from ExternalConnection.)
Public propertyEditPage Obsolete.
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.
Public propertyEditWebPage
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.
Public propertyHtmlFormat
How to handle formatting from the HTML source when bringing web query data into the worksheet. Relevant when sourceData is True.
Public propertyId
Gets the id of the connection.
(Inherited from ExternalConnection.)
Public propertyIsConsecutive
Flag indicating whether consecutive delimiters should be treated as just one delimiter.
Public propertyIsDeleted
Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
(Inherited from ExternalConnection.)
Public propertyIsHtmlTables
Flag indicating whether web queries should only work on HTML tables.
Public propertyIsNew
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.
(Inherited from ExternalConnection.)
Public propertyIsParsePre
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.
Public propertyIsSameSettings
Flag indicating whether to parse all tables inside a PRE block with the same width settings as the first row.
Public propertyIsTextDates
Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates.
Public propertyIsXl2000
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.
Public propertyIsXl97
This flag exists for backward compatibility with older existing spreadhseet 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.
Public propertyIsXml
true if the web query source is XML (versus HTML), otherwise false.
Public propertyIsXmlSourceData
Flag indicating that XML source data should be imported instead of the HTML table itself.
Public propertyKeepAlive
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.
(Inherited from ExternalConnection.)
Public propertyName
Specifies the name of the connection. Each connection must have a unique name.
(Inherited from ExternalConnection.)
Public propertyOdcFile
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.
(Inherited from ExternalConnection.)
Public propertyOnlyUseConnectionFile
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
(Inherited from ExternalConnection.)
Public propertyParameters
Gets ConnectionParameterCollection for an ODBC or web query.
(Inherited from ExternalConnection.)
Public propertyPost
Returns or sets the string used with the post method of inputting data into a web server to return data from a web query.
Public propertyReconnectionMethod Obsolete.
Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required.
(Inherited from ExternalConnection.)
Public propertyReconnectionMethodType
Specifies what the spreadsheet application should do when a connection fails.The default value is ReConnectionMethodType.Required.
(Inherited from ExternalConnection.)
Public propertyRefreshInternal
Specifies the number of minutes between automatic refreshes of the connection.
(Inherited from ExternalConnection.)
Public propertyRefreshOnLoad
True if this connection should be refreshed when opening the file; otherwise, false.
(Inherited from ExternalConnection.)
Public propertySaveData
True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
(Inherited from ExternalConnection.)
Public propertySavePassword
True if the password is to be saved as part of the connection string; otherwise, False.
(Inherited from ExternalConnection.)
Public propertySourceFile
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.
(Inherited from ExternalConnection.)
Public propertySSOId
Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
(Inherited from ExternalConnection.)
Public propertyType
Gets or Sets the external connection DataSource type.
(Inherited from ExternalConnection.)
Public propertyUrl
URL to use to refresh external data.
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
See Also