com.aspose.cells.WebQueryConnection.html Maven / Gradle / Ivy

Go to download






WebQueryConnection





com.aspose.cells

Class WebQueryConnection
java.lang.Object
  ExternalConnection
      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



boolean getBackgroundRefresh() → inherited from ExternalConnection
void setBackgroundRefresh(boolean) 
          
            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.String getConnectionDescription() → inherited from ExternalConnection
void setConnectionDescription(java.lang.String) 
          
            Specifies the user description for this connection
            



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



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



int getCredentialsMethodType() → inherited from ExternalConnection
void setCredentialsMethodType(int) 
          
            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.String getEditPage() 
void setEditPage(java.lang.String) 
          
            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.
            



java.lang.String getEditWebPage() 
void setEditWebPage(java.lang.String) 
          
            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.
            



int getHtmlFormat() 
void setHtmlFormat(int) 
          
            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.



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



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



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



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



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



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



boolean isSameSettings() 
void setSameSettings(boolean) 
          
            Flag indicating whether to parse all tables inside a PRE block with the same width settings
            as the first row.
            



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



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



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



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



boolean isXmlSourceData() 
void setXmlSourceData(boolean) 
          
            Flag indicating that XML source data should be imported instead of the HTML table itself.        
            



boolean getKeepAlive() → inherited from ExternalConnection
void setKeepAlive(boolean) 
          
            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.String getName() → inherited from ExternalConnection
void setName(java.lang.String) 
          
            Specifies the name of the connection. Each connection must have a unique name. 
            



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



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



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



java.lang.String getPost() 
void setPost(java.lang.String) 
          
            Returns or sets the string used with the post method of inputting data into a web server
            to return data from a web query.
            



Aspose.Cells.QueryTables.PowerQueryFormula getPowerQueryFormula() → inherited from ExternalConnection
          
            Gets the definition of power query formula.
            



int getReconnectionMethod() → inherited from ExternalConnection
void setReconnectionMethod(int) 
          
            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.



int getReconnectionMethodType() → inherited from ExternalConnection
void setReconnectionMethodType(int) 
          
            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.



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



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



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



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



java.lang.String getSourceFile() → inherited from ExternalConnection
void setSourceFile(java.lang.String) 
          
            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.String getSSOId() → inherited from ExternalConnection
void setSSOId(java.lang.String) 
          
            Identifier for Single Sign On (SSO) used for authentication between an intermediate 
            spreadsheetML server and the external data source.
            



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



java.lang.String getUrl() 
void setUrl(java.lang.String) 
          
            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.
            



setXml 
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 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.
            



setXl97 
public void setXl97(boolean 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.
            




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.
            



setXl2000 
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.
            



setUrl 
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.
            



setTextDates 
public void setTextDates(boolean value)


            Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates.
            




isXmlSourceData/setXmlSourceData 
public boolean isXmlSourceData() / public void setXmlSourceData(boolean value)


            Flag indicating that XML source data should be imported instead of the HTML table itself.        
            



setXmlSourceData 
public void setXmlSourceData(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.
            



setPost 
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.
            



setParsePre 
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.
            



setHtmlTables 
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.



setHtmlFormat 
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.




isSameSettings/setSameSettings 
public boolean isSameSettings() / public void setSameSettings(boolean value)


            Flag indicating whether to parse all tables inside a PRE block with the same width settings
            as the first row.
            



setSameSettings 
public void setSameSettings(boolean value)


            Flag indicating whether to parse all tables inside a PRE block with the same width settings
            as the first row.
            




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



setEditWebPage 
public void setEditWebPage(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.
            




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.
            

            NOTE: This property is now obsolete. Instead, 
            please use WebQueryConnection.EditWebPage property.
            This property will be removed 12 months later since October 2017. 
            Aspose apologizes for any inconvenience you may have experienced.



setEditPage 
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.
            

            NOTE: This property is now obsolete. Instead, 
            please use WebQueryConnection.EditWebPage property.
            This property will be removed 12 months later since October 2017. 
            Aspose apologizes for any inconvenience you may have experienced.




isConsecutive/setConsecutive 
public boolean isConsecutive() / public void setConsecutive(boolean value)


            Flag indicating whether consecutive delimiters should be treated as just one delimiter.
            



setConsecutive 
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.
            



getPowerQueryFormula → inherited from ExternalConnection

public Aspose.Cells.QueryTables.PowerQueryFormula getPowerQueryFormula()


            Gets the definition of power query formula.
            



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.



setType → inherited from ExternalConnection

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.
            



setSourceFile → inherited from ExternalConnection

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.
            



setSSOId → inherited from ExternalConnection

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.
            



setSavePassword → inherited from ExternalConnection

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. 
            



setSaveData → inherited from ExternalConnection

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/setRefreshOnLoad → inherited from ExternalConnection

public boolean getRefreshOnLoad() / public void setRefreshOnLoad(boolean value)


            True if this connection should be refreshed when opening the file; otherwise, false.
            



setRefreshOnLoad → inherited from ExternalConnection

public void setRefreshOnLoad(boolean value)


            True if this connection should be refreshed when opening the file; otherwise, false.
            




getReconnectionMethodType/setReconnectionMethodType → inherited from ExternalConnection

public int getReconnectionMethodType() / public void setReconnectionMethodType(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.



setReconnectionMethodType → inherited from ExternalConnection

public void setReconnectionMethodType(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.




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.

            NOTE: This property is now obsolete. Instead, 
            please use ExternalConnection.ReconnectionMethodType property.
            This property will be removed 12 months later since October 2017. 
            Aspose apologizes for any inconvenience you may have experienced.



setReconnectionMethod → inherited from ExternalConnection

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.

            NOTE: This property is now obsolete. Instead, 
            please use ExternalConnection.ReconnectionMethodType property.
            This property will be removed 12 months later since October 2017. 
            Aspose apologizes for any inconvenience you may have experienced.




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
            



setOnlyUseConnectionFile → inherited from ExternalConnection

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. 
            



setOdcFile → inherited from ExternalConnection

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.
            



setNew → inherited from ExternalConnection

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. 
            



setName → inherited from ExternalConnection

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.  
            



setKeepAlive → inherited from ExternalConnection

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.
            



setRefreshInternal → inherited from ExternalConnection

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
            



setConnectionDescription → inherited from ExternalConnection

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.
            



setDeleted → inherited from ExternalConnection

public void setDeleted(boolean value)


            Indicates whether the associated workbook connection has been deleted.  true if the
            connection has been deleted; otherwise, false.
            




getCredentialsMethodType/setCredentialsMethodType → inherited from ExternalConnection

public int getCredentialsMethodType() / public void setCredentialsMethodType(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.



setCredentialsMethodType → inherited from ExternalConnection

public void setCredentialsMethodType(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.




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.

            NOTE: This property is now obsolete. Instead, 
            please use ExternalConnection.CredentialsMethodType property.
            This property will be removed 12 months later since October 2017. 
            Aspose apologizes for any inconvenience you may have experienced.



setCredentials → inherited from ExternalConnection

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.

            NOTE: This property is now obsolete. Instead, 
            please use ExternalConnection.CredentialsMethodType property.
            This property will be removed 12 months later since October 2017. 
            Aspose apologizes for any inconvenience you may have experienced.




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.
            



setBackgroundRefresh → inherited from ExternalConnection

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.Cells Product Documentation.

          Aspose.Cells Support Forum - our preferred method of support.
We guarantee a prompt response to any inquiry!
© 2003-2022 Aspose Pty Ltd. All rights reserved.

Property Getters/Setters Summary
`boolean`	`getBackgroundRefresh()`	`→ inherited from ExternalConnection`
`void`	`setBackgroundRefresh(boolean)`
	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.String`	`getConnectionDescription()`	`→ inherited from ExternalConnection`
`void`	`setConnectionDescription(java.lang.String)`
	Specifies the user description for this connection
`int`	`getConnectionId()`	`→ inherited from ExternalConnection`
	Specifies The unique identifier of this connection.
`int`	`getCredentials()`	`→ inherited from ExternalConnection`
`void`	`setCredentials(int)`
	Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the property is CredentialsMethodType integer constant.
`int`	`getCredentialsMethodType()`	`→ inherited from ExternalConnection`
`void`	`setCredentialsMethodType(int)`
	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.String`	`getEditPage()`
`void`	`setEditPage(java.lang.String)`
	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.
`java.lang.String`	`getEditWebPage()`
`void`	`setEditWebPage(java.lang.String)`
	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.
`int`	`getHtmlFormat()`
`void`	`setHtmlFormat(int)`
	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.
`int`	`getId()`	`→ inherited from ExternalConnection`
	Gets the id of the connection.
`boolean`	`isConsecutive()`
`void`	`setConsecutive(boolean)`
	Flag indicating whether consecutive delimiters should be treated as just one delimiter.
`boolean`	`isDeleted()`	`→ inherited from ExternalConnection`
`void`	`setDeleted(boolean)`
	Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
`boolean`	`isHtmlTables()`
`void`	`setHtmlTables(boolean)`
	Flag indicating whether web queries should only work on HTML tables.
`boolean`	`isNew()`	`→ inherited from ExternalConnection`
`void`	`setNew(boolean)`
	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.
`boolean`	`isParsePre()`
`void`	`setParsePre(boolean)`
	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.
`boolean`	`isSameSettings()`
`void`	`setSameSettings(boolean)`
	Flag indicating whether to parse all tables inside a PRE block with the same width settings as the first row.
`boolean`	`isTextDates()`
`void`	`setTextDates(boolean)`
	Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates.
`boolean`	`isXl2000()`
`void`	`setXl2000(boolean)`
	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.
`boolean`	`isXl97()`
`void`	`setXl97(boolean)`
	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.
`boolean`	`isXml()`
`void`	`setXml(boolean)`
	true if the web query source is XML (versus HTML), otherwise false.
`boolean`	`isXmlSourceData()`
`void`	`setXmlSourceData(boolean)`
	Flag indicating that XML source data should be imported instead of the HTML table itself.
`boolean`	`getKeepAlive()`	`→ inherited from ExternalConnection`
`void`	`setKeepAlive(boolean)`
	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.String`	`getName()`	`→ inherited from ExternalConnection`
`void`	`setName(java.lang.String)`
	Specifies the name of the connection. Each connection must have a unique name.
`java.lang.String`	`getOdcFile()`	`→ inherited from ExternalConnection`
`void`	`setOdcFile(java.lang.String)`
	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.
`boolean`	`getOnlyUseConnectionFile()`	`→ inherited from ExternalConnection`
`void`	`setOnlyUseConnectionFile(boolean)`
	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
`ConnectionParameterCollection`	`getParameters()`	`→ inherited from ExternalConnection`
	Gets ConnectionParameterCollection for an ODBC or web query.
`java.lang.String`	`getPost()`
`void`	`setPost(java.lang.String)`
	Returns or sets the string used with the post method of inputting data into a web server to return data from a web query.
`Aspose.Cells.QueryTables.PowerQueryFormula`	`getPowerQueryFormula()`	`→ inherited from ExternalConnection`
	Gets the definition of power query formula.
`int`	`getReconnectionMethod()`	`→ inherited from ExternalConnection`
`void`	`setReconnectionMethod(int)`
	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.
`int`	`getReconnectionMethodType()`	`→ inherited from ExternalConnection`
`void`	`setReconnectionMethodType(int)`
	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.
`int`	`getRefreshInternal()`	`→ inherited from ExternalConnection`
`void`	`setRefreshInternal(int)`
	Specifies the number of minutes between automatic refreshes of the connection.
`boolean`	`getRefreshOnLoad()`	`→ inherited from ExternalConnection`
`void`	`setRefreshOnLoad(boolean)`
	True if this connection should be refreshed when opening the file; otherwise, false.
`boolean`	`getSaveData()`	`→ inherited from ExternalConnection`
`void`	`setSaveData(boolean)`
	True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
`boolean`	`getSavePassword()`	`→ inherited from ExternalConnection`
`void`	`setSavePassword(boolean)`
	True if the password is to be saved as part of the connection string; otherwise, False.
`java.lang.String`	`getSourceFile()`	`→ inherited from ExternalConnection`
`void`	`setSourceFile(java.lang.String)`
	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.String`	`getSSOId()`	`→ inherited from ExternalConnection`
`void`	`setSSOId(java.lang.String)`
	Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
`int`	`getType()`	`→ inherited from ExternalConnection`
`void`	`setType(int)`
	Gets or Sets the external connection DataSource type. The value of the property is ConnectionDataSourceType integer constant.
`java.lang.String`	`getUrl()`
`void`	`setUrl(java.lang.String)`
	URL to use to refresh external data.

isXml/setXml
public boolean isXml() / public void setXml(boolean value)

isXl97/setXl97
public boolean isXl97() / public void setXl97(boolean value)

isXl2000/setXl2000
public boolean isXl2000() / public void setXl2000(boolean value)

getUrl/setUrl
public java.lang.String getUrl() / public void setUrl(java.lang.String value)

isTextDates/setTextDates
public boolean isTextDates() / public void setTextDates(boolean value)

isXmlSourceData/setXmlSourceData
public boolean isXmlSourceData() / public void setXmlSourceData(boolean value)

setXmlSourceData
public void setXmlSourceData(boolean value)

getPost/setPost
public java.lang.String getPost() / public void setPost(java.lang.String value)

isParsePre/setParsePre
public boolean isParsePre() / public void setParsePre(boolean value)

isHtmlTables/setHtmlTables
public boolean isHtmlTables() / public void setHtmlTables(boolean value)

getHtmlFormat/setHtmlFormat
public int getHtmlFormat() / public void setHtmlFormat(int value)

isSameSettings/setSameSettings
public boolean isSameSettings() / public void setSameSettings(boolean value)

setSameSettings
public void setSameSettings(boolean value)

getEditWebPage/setEditWebPage
public java.lang.String getEditWebPage() / public void setEditWebPage(java.lang.String value)

setEditWebPage
public void setEditWebPage(java.lang.String value)

getEditPage/setEditPage
public java.lang.String getEditPage() / public void setEditPage(java.lang.String value)

setEditPage
public void setEditPage(java.lang.String value)

isConsecutive/setConsecutive
public boolean isConsecutive() / public void setConsecutive(boolean value)

getId	`→ inherited from ExternalConnection`
public int getId()

getPowerQueryFormula	`→ inherited from ExternalConnection`
public Aspose.Cells.QueryTables.PowerQueryFormula getPowerQueryFormula()

com.aspose.cells.WebQueryConnection.html Maven / Gradle / Ivy

com.aspose.cells Class WebQueryConnection

isXml/setXml

setXml

isXl97/setXl97

setXl97

isXl2000/setXl2000

setXl2000

getUrl/setUrl

setUrl

isTextDates/setTextDates

setTextDates

isXmlSourceData/setXmlSourceData

setXmlSourceData

getPost/setPost

setPost

isParsePre/setParsePre

setParsePre

isHtmlTables/setHtmlTables

setHtmlTables

getHtmlFormat/setHtmlFormat

setHtmlFormat

isSameSettings/setSameSettings

setSameSettings

getEditWebPage/setEditWebPage

setEditWebPage

getEditPage/setEditPage

setEditPage

isConsecutive/setConsecutive

setConsecutive

getId

getPowerQueryFormula

getType/setType

setType

getSourceFile/setSourceFile

setSourceFile

getSSOId/setSSOId

setSSOId

getSavePassword/setSavePassword

setSavePassword

getSaveData/setSaveData

setSaveData

getRefreshOnLoad/setRefreshOnLoad

setRefreshOnLoad

getReconnectionMethodType/setReconnectionMethodType

setReconnectionMethodType

getReconnectionMethod/setReconnectionMethod

setReconnectionMethod

getOnlyUseConnectionFile/setOnlyUseConnectionFile

setOnlyUseConnectionFile

getOdcFile/setOdcFile

setOdcFile

isNew/setNew

setNew

getName/setName

setName

getKeepAlive/setKeepAlive

setKeepAlive

getRefreshInternal/setRefreshInternal

setRefreshInternal

getConnectionId

getConnectionDescription/setConnectionDescription

setConnectionDescription

isDeleted/setDeleted

setDeleted

getCredentialsMethodType/setCredentialsMethodType

setCredentialsMethodType

getCredentials/setCredentials

setCredentials

getBackgroundRefresh/setBackgroundRefresh

setBackgroundRefresh

getParameters

com.aspose.cells
Class WebQueryConnection

getType/setType	`→ inherited from ExternalConnection`
public int getType() / public void setType(int value)

setType	`→ inherited from ExternalConnection`
public void setType(int value)

getSourceFile/setSourceFile	`→ inherited from ExternalConnection`
public java.lang.String getSourceFile() / public void setSourceFile(java.lang.String value)

setSourceFile	`→ inherited from ExternalConnection`
public void setSourceFile(java.lang.String value)

getSSOId/setSSOId	`→ inherited from ExternalConnection`
public java.lang.String getSSOId() / public void setSSOId(java.lang.String value)

setSSOId	`→ inherited from ExternalConnection`
public void setSSOId(java.lang.String value)

getSavePassword/setSavePassword	`→ inherited from ExternalConnection`
public boolean getSavePassword() / public void setSavePassword(boolean value)

setSavePassword	`→ inherited from ExternalConnection`
public void setSavePassword(boolean value)

getSaveData/setSaveData	`→ inherited from ExternalConnection`
public boolean getSaveData() / public void setSaveData(boolean value)

setSaveData	`→ inherited from ExternalConnection`
public void setSaveData(boolean value)