com.aspose.cells
Class WebQueryConnection

java.lang.Object
  extended by ExternalConnection
      extended by com.aspose.cells.WebQueryConnection

public class WebQueryConnection 
extends ExternalConnection

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.

Property Getters/Setters Summary
booleangetBackgroundRefresh()→ inherited from ExternalConnection
voidsetBackgroundRefresh(boolean 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.
java.lang.StringgetConnectionDescription()→ inherited from ExternalConnection
voidsetConnectionDescription(java.lang.String value)
           Specifies the user description for this connection
intgetConnectionId()→ inherited from ExternalConnection
           Specifies The unique identifier of this connection.
intgetCredentials()→ inherited from ExternalConnection
voidsetCredentials(int value)
           Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the property is CredentialsMethodType integer constant.
java.lang.StringgetEditPage()
voidsetEditPage(java.lang.String 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.
intgetHtmlFormat()
voidsetHtmlFormat(int value)
           How to handle formatting from the HTML source when bringing web query data into the worksheet. Relevant when sourceData is True. The value of the property is HtmlFormatHandlingType integer constant.
intgetId()→ inherited from ExternalConnection
           Gets the id of the connection.
booleanisConsecutive()
voidsetConsecutive(boolean value)
           Flag indicating whether consecutive delimiters should be treated as just one delimiter.
booleanisDeleted()→ inherited from ExternalConnection
voidsetDeleted(boolean value)
           Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
booleanisFirstRow()
voidsetFirstRow(boolean value)
           Flag indicating whether to parse all tables inside a PRE block with the same width settings as the first row.
booleanisHtmlTables()
voidsetHtmlTables(boolean value)
           Flag indicating whether web queries should only work on HTML tables.
booleanisNew()→ inherited from ExternalConnection
voidsetNew(boolean 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.
booleanisParsePre()
voidsetParsePre(boolean 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.
booleanisSourceData()
voidsetSourceData(boolean value)
           Flag indicating that XML source data should be imported instead of the HTML table itself.
booleanisTextDates()
voidsetTextDates(boolean value)
           Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates.
booleanisXl2000()
voidsetXl2000(boolean 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.
booleanisXl97()
voidsetXl97(boolean value)
           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.
booleanisXml()
voidsetXml(boolean value)
           true if the web query source is XML (versus HTML), otherwise false.
booleangetKeepAlive()→ inherited from ExternalConnection
voidsetKeepAlive(boolean 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.
java.lang.StringgetName()→ inherited from ExternalConnection
voidsetName(java.lang.String value)
           Specifies the name of the connection. Each connection must have a unique name.
java.lang.StringgetOdcFile()→ inherited from ExternalConnection
voidsetOdcFile(java.lang.String 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.
booleangetOnlyUseConnectionFile()→ inherited from ExternalConnection
voidsetOnlyUseConnectionFile(boolean 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
ConnectionParameterCollectiongetParameters()→ inherited from ExternalConnection
           Gets ConnectionParameterCollection for an ODBC or web query.
java.lang.StringgetPost()
voidsetPost(java.lang.String 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.
intgetReConnectionMethod()→ inherited from ExternalConnection
voidsetReConnectionMethod(int value)
           Specifies what the spreadsheet application should do when a connection fails.The default value is ReConnectionMethodType.Required. The value of the property is ReConnectionMethodType integer constant.
intgetRefreshInternal()→ inherited from ExternalConnection
voidsetRefreshInternal(int value)
           Specifies the number of minutes between automatic refreshes of the connection.
booleangetRefreshOnLoad()→ inherited from ExternalConnection
           True if this connection should be refreshed when opening the file; otherwise, false.
booleangetSaveData()→ inherited from ExternalConnection
voidsetSaveData(boolean value)
           True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
booleangetSavePassword()→ inherited from ExternalConnection
voidsetSavePassword(boolean value)
           True if the password is to be saved as part of the connection string; otherwise, False.
java.lang.StringgetSourceFile()→ inherited from ExternalConnection
voidsetSourceFile(java.lang.String 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.
java.lang.StringgetSSOId()→ inherited from ExternalConnection
voidsetSSOId(java.lang.String value)
           Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
intgetType()→ inherited from ExternalConnection
voidsetType(int value)
           Gets or Sets the external connection DataSource type. The value of the property is ConnectionDataSourceType integer constant.
java.lang.StringgetUrl()
voidsetUrl(java.lang.String value)
           URL to use to refresh external data.
 

Property Getters/Setters Detail

isXml/setXml

public boolean isXml() / public void setXml(boolean value)
true if the web query source is XML (versus HTML), otherwise false.

isXl97/setXl97

public boolean isXl97() / public void setXl97(boolean value)
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.

isXl2000/setXl2000

public boolean isXl2000() / public void setXl2000(boolean 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.

getUrl/setUrl

public java.lang.String getUrl() / public void setUrl(java.lang.String value)
URL to use to refresh external data.

isTextDates/setTextDates

public boolean isTextDates() / public void setTextDates(boolean value)
Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates.

isSourceData/setSourceData

public boolean isSourceData() / public void setSourceData(boolean value)
Flag indicating that XML source data should be imported instead of the HTML table itself.

getPost/setPost

public java.lang.String getPost() / public void setPost(java.lang.String 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.

isParsePre/setParsePre

public boolean isParsePre() / public void setParsePre(boolean 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.

isHtmlTables/setHtmlTables

public boolean isHtmlTables() / public void setHtmlTables(boolean value)
Flag indicating whether web queries should only work on HTML tables.

getHtmlFormat/setHtmlFormat

public int getHtmlFormat() / public void setHtmlFormat(int value)
How to handle formatting from the HTML source when bringing web query data into the worksheet. Relevant when sourceData is True. The value of the property is HtmlFormatHandlingType integer constant.

isFirstRow/setFirstRow

public boolean isFirstRow() / public void setFirstRow(boolean value)
Flag indicating whether to parse all tables inside a PRE block with the same width settings as the first row.

getEditPage/setEditPage

public java.lang.String getEditPage() / public void setEditPage(java.lang.String 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.

isConsecutive/setConsecutive

public boolean isConsecutive() / public void setConsecutive(boolean value)
Flag indicating whether consecutive delimiters should be treated as just one delimiter.

getId

→ inherited from ExternalConnection
public int getId()
Gets the id of the connection.

getType/setType

→ inherited from ExternalConnection
public int getType() / public void setType(int value)
Gets or Sets the external connection DataSource type. The value of the property is ConnectionDataSourceType integer constant.

getSourceFile/setSourceFile

→ inherited from ExternalConnection
public java.lang.String getSourceFile() / public void setSourceFile(java.lang.String 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.

getSSOId/setSSOId

→ inherited from ExternalConnection
public java.lang.String getSSOId() / public void setSSOId(java.lang.String value)
Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.

getSavePassword/setSavePassword

→ inherited from ExternalConnection
public boolean getSavePassword() / public void setSavePassword(boolean value)
True if the password is to be saved as part of the connection string; otherwise, False.

getSaveData/setSaveData

→ inherited from ExternalConnection
public boolean getSaveData() / public void setSaveData(boolean value)
True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.

getRefreshOnLoad

→ inherited from ExternalConnection
public boolean getRefreshOnLoad()
True if this connection should be refreshed when opening the file; otherwise, false.

getReConnectionMethod/setReConnectionMethod

→ inherited from ExternalConnection
public int getReConnectionMethod() / public void setReConnectionMethod(int value)
Specifies what the spreadsheet application should do when a connection fails.The default value is ReConnectionMethodType.Required. The value of the property is ReConnectionMethodType integer constant.

getOnlyUseConnectionFile/setOnlyUseConnectionFile

→ inherited from ExternalConnection
public boolean getOnlyUseConnectionFile() / public void setOnlyUseConnectionFile(boolean 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

getOdcFile/setOdcFile

→ inherited from ExternalConnection
public java.lang.String getOdcFile() / public void setOdcFile(java.lang.String 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.

isNew/setNew

→ inherited from ExternalConnection
public boolean isNew() / public void setNew(boolean 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.

getName/setName

→ inherited from ExternalConnection
public java.lang.String getName() / public void setName(java.lang.String value)
Specifies the name of the connection. Each connection must have a unique name.

getKeepAlive/setKeepAlive

→ inherited from ExternalConnection
public boolean getKeepAlive() / public void setKeepAlive(boolean 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.

getRefreshInternal/setRefreshInternal

→ inherited from ExternalConnection
public int getRefreshInternal() / public void setRefreshInternal(int value)
Specifies the number of minutes between automatic refreshes of the connection.

getConnectionId

→ inherited from ExternalConnection
public int getConnectionId()
Specifies The unique identifier of this connection.

getConnectionDescription/setConnectionDescription

→ inherited from ExternalConnection
public java.lang.String getConnectionDescription() / public void setConnectionDescription(java.lang.String value)
Specifies the user description for this connection

isDeleted/setDeleted

→ inherited from ExternalConnection
public boolean isDeleted() / public void setDeleted(boolean value)
Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.

getCredentials/setCredentials

→ inherited from ExternalConnection
public int getCredentials() / public void setCredentials(int value)
Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the property is CredentialsMethodType integer constant.

getBackgroundRefresh/setBackgroundRefresh

→ inherited from ExternalConnection
public boolean getBackgroundRefresh() / public void setBackgroundRefresh(boolean 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.

getParameters

→ inherited from ExternalConnection
public ConnectionParameterCollection getParameters()
Gets ConnectionParameterCollection for an ODBC or web query.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.