com.aspose.cells
Classes 
AboveAverage
AbstractCalculationEngine
AbstractCalculationMonitor
AbstractGlobalizationSettings
AbstractInterruptMonitor
AbstractTextLoadOptions
ActiveXControl
ActiveXControlBase
ArcShape
Area
AutoFilter
AutoFitterOptions
AutomaticFill
AutoNumberedBulletValue
Axis
AxisBins
BaseShapeGuide
Bevel
Border
BorderCollection
BuiltInDocumentPropertyCollection
Bullet
BulletValue
Button
CalculationCell
CalculationData
CalculationOptions
Cell
CellArea
Cells
CellsColor
CellsDataTableFactory
CellsDrawing
CellsException
CellsFactory
CellsHelper
CellWatch
CellWatchCollection
CharacterBulletValue
Chart
ChartArea
ChartCollection
ChartDataTable
ChartFrame
ChartGlobalizationSettings
ChartPoint
ChartPointCollection
ChartShape
ChartTextFrame
CheckBox
CheckBoxActiveXControl
CheckBoxCollection
CollectionBase
Color
ColorFilter
ColorHelper
ColorScale
Column
ColumnCollection
ComboBox
ComboBoxActiveXControl
CommandButtonActiveXControl
Comment
CommentCollection
CommentShape
ConditionalFormattingCollection
ConditionalFormattingIcon
ConditionalFormattingIconCollection
ConditionalFormattingResult
ConditionalFormattingValue
ConditionalFormattingValueCollection
ConnectionParameter
ConnectionParameterCollection
ContentTypeProperty
ContentTypePropertyCollection
CopyOptions
CustomDocumentPropertyCollection
CustomFilter
CustomFilterCollection
CustomGeometry
CustomImplementationFactory
CustomProperty
CustomPropertyCollection
CustomXmlPart
CustomXmlPartCollection
CustomXmlShape
DataBar
DataBarBorder
DataLabels
DataSorter
DataSorterKey
DataSorterKeyCollection
DateTime
DateTimeGroupItem
DBConnection
DefaultStyleSettings
DeleteOptions
DialogBox
DifSaveOptions
DigitalSignature
DigitalSignatureCollection
DisplayUnitLabel
DocumentProperty
DocumentPropertyCollection
DocxSaveOptions
DrawObject
DrawObjectEventHandler
DropBars
DxfCollection
DynamicFilter
Encoding
ErrorBar
ErrorCheckOption
ErrorCheckOptionCollection
ExportObjectEvent
ExportRangeToJsonOptions
ExportTableOptions
ExternalConnection
ExternalConnectionCollection
ExternalLink
ExternalLinkCollection
FileFontSource
FileFormatInfo
FileFormatUtil
Fill
FillFormat
FilterColumn
FilterColumnCollection
FindOptions
Floor
FolderFontSource
Font
FontConfigs
FontSetting
FontSettingCollection
FontSourceBase
Format3D
FormatCondition
FormatConditionCollection
FormulaParseOptions
FormulaSettings
Geometry
GlobalizationSettings
GlowEffect
GradientFill
GradientStop
GradientStopCollection
GroupBox
GroupFill
GroupShape
HeaderFooterCommand
HorizontalPageBreak
HorizontalPageBreakCollection
HtmlLoadOptions
HtmlSaveOptions
Hyperlink
HyperlinkCollection
IconFilter
IconSet
ImageActiveXControl
ImageFormat
ImageOrPrintOptions
ImageSaveOptions
ImportTableOptions
IndividualFontConfigs
InsertOptions
InterruptMonitor
JsonLayoutOptions
JsonLoadOptions
JsonSaveOptions
JsonUtility
Label
LabelActiveXControl
Legend
LegendEntry
LegendEntryCollection
License
Line
LineFormat
LineShape
ListBox
ListBoxActiveXControl
ListColumn
ListColumnCollection
ListObject
ListObjectCollection
LoadFilter
LoadOptions
MarkdownSaveOptions
Marker
MemoryFontSource
MetadataOptions
Metered
MsoFillFormat
MsoFillFormatHelper
MsoFormatPicture
MsoLineFormat
MsoLineFormatHelper
MsoTextFrame
MultipleFilterCollection
Name
NameCollection
NegativeBarFormat
NoneBulletValue
NoneFill
OdsCellField
OdsCellFieldCollection
OdsLoadOptions
OdsPageBackground
OdsSaveOptions
OleObject
OleObjectCollection
OoxmlSaveOptions
Outline
Oval
PageEndSavingArgs
PageSavingArgs
PageSetup
PageStartSavingArgs
PaginatedSaveOptions
PaneCollection
PasteOptions
PatternFill
PdfBookmarkEntry
PdfSaveOptions
PdfSecurityOptions
PicFormatOption
Picture
PictureBulletValue
PictureCollection
PivotField
PivotFieldCollection
PivotFilter
PivotFilterCollection
PivotFormatCondition
PivotFormatConditionCollection
PivotItem
PivotItemCollection
PivotOptions
PivotPageFields
PivotTable
PivotTableCollection
PlotArea
PptxSaveOptions
ProtectedRange
ProtectedRangeCollection
Protection
QueryTable
QueryTableCollection
RadioButton
RadioButtonActiveXControl
Range
RangeCollection
RectangleShape
ReferredArea
ReferredAreaCollection
ReflectionEffect
ReplaceOptions
Revision
RevisionAutoFormat
RevisionCellChange
RevisionCellComment
RevisionCellMove
RevisionCollection
RevisionCustomView
RevisionDefinedName
RevisionFormat
RevisionInsertDelete
RevisionInsertSheet
RevisionLog
RevisionLogCollection
RevisionMergeConflict
RevisionQueryTable
RevisionRenameSheet
Row
RowCollection
SaveOptions
Scenario
ScenarioCollection
ScenarioInputCell
ScenarioInputCellCollection
ScrollBar
ScrollBarActiveXControl
Series
SeriesCollection
SeriesLayoutProperties
ShadowEffect
Shape
ShapeCollection
ShapeFormat
ShapeGuide
ShapeGuideCollection
ShapePath
ShapePathCollection
ShapePathPoint
ShapePathPointCollection
ShapePropertyCollection
ShapeSegmentPath
ShapeSegmentPathCollection
ShapeTextAlignment
SheetPrintingPreview
SheetRender
SheetSet
SignatureLine
Slicer
SlicerCache
SlicerCacheItem
SlicerCacheItemCollection
SlicerCollection
SmartArtShape
SmartTag
SmartTagCollection
SmartTagOptions
SmartTagProperty
SmartTagPropertyCollection
SmartTagSetting
SolidFill
Sparkline
SparklineCollection
SparklineGroup
SparklineGroupCollection
SpinButtonActiveXControl
Spinner
SpreadsheetML2003SaveOptions
StreamProviderOptions
Style
StyleFlag
SubtotalSetting
SvgSaveOptions
SxRng
TableStyle
TableStyleCollection
TableStyleElement
TableStyleElementCollection
TableToRangeOptions
TextBox
TextBoxActiveXControl
TextBoxCollection
TextEffectFormat
TextOptions
TextParagraph
TextParagraphCollection
TextTabStop
TextTabStopCollection
TextureFill
ThemeColor
ThreadedComment
ThreadedCommentAuthor
ThreadedCommentAuthorCollection
ThreadedCommentCollection
ThreeDFormat
TickLabelItem
TickLabels
TilePicOption
Timeline
TimelineCollection
Title
ToggleButtonActiveXControl
Top10
Top10Filter
Trendline
TrendlineCollection
TxtLoadOptions
TxtSaveOptions
UnionRange
UnknownControl
Validation
ValidationCollection
VbaModule
VbaModuleCollection
VbaProject
VbaProjectReference
VbaProjectReferenceCollection
VerticalPageBreak
VerticalPageBreakCollection
VmlShapeGuide
Walls
WarningInfo
WebExtension
WebExtensionBinding
WebExtensionBindingCollection
WebExtensionCollection
WebExtensionProperty
WebExtensionPropertyCollection
WebExtensionReference
WebExtensionReferenceCollection
WebExtensionShape
WebExtensionTaskPane
WebExtensionTaskPaneCollection
WebQueryConnection
Workbook
WorkbookDesigner
WorkbookMetadata
WorkbookPrintingPreview
WorkbookRender
WorkbookSettings
Worksheet
WorksheetCollection
WriteProtection
XlsbSaveOptions
XlsSaveOptions
XmlColumnProperty
XmlDataBinding
XmlLoadOptions
XmlMap
XmlMapCollection
XmlSaveOptions
XpsSaveOptions
Interfaces 
ICellsDataTable
ICustomFunction
ICustomParser
IExportObjectListener
IFilePathProvider
IPageSavingCallback
ISmartMarkerCallBack
IStreamProvider
IWarningCallback
LightCellsDataHandler
LightCellsDataProvider
Constants 
AccessCacheOptions
ActiveXPersistenceType
AutoFillType
AutoFitMergedCellsType
AutoFitWrappedTextType
AutoShapeType
AxisType
BackgroundMode
BackgroundType
Bar3DShapeType
BevelPresetType
BevelType
BorderType
BubbleSizeRepresents
BuiltinStyleType
BulletType
CalcModeType
CalculationPrecisionStrategy
CategoryType
CellBorderType
CellValueFormatStrategy
CellValueType
ChartLineFormattingType
ChartMarkerType
ChartSplitType
ChartTextDirectionType
ChartType
CheckValueType
ColorDepth
ColorType
CommentTitleType
ConnectionDataSourceType
ConnectionParameterType
ConsolidationFunction
ControlBorderType
ControlCaptionAlignmentType
ControlListStyle
ControlMatchEntryType
ControlMousePointerType
ControlPictureAlignmentType
ControlPicturePositionType
ControlPictureSizeMode
ControlScrollBarType
ControlScrollOrientation
ControlSpecialEffectType
ControlType
CopyFormatType
CountryCode
CredentialsMethodType
CrossType
DataBarAxisPosition
DataBarBorderType
DataBarFillType
DataBarNegativeColorType
DataLabelShapeType
DataLabelsSeparatorType
DataLablesSeparatorType
DateTimeGroupingType
DefaultEditLanguage
DirectoryType
DisplayDrawingObjects
DisplayUnitType
DrawObjectEnum
DropButtonStyle
DynamicFilterType
EmfRenderSetting
EncryptionType
ErrorBarDisplayType
ErrorBarType
ErrorCheckType
ExceptionType
ExternalLinkType
FileFormatType
FillPattern
FillPictureType
FillType
FilterOperatorType
FilterType
FontSchemeType
FontSourceType
FontUnderlineType
FormatConditionType
FormatConditionValueType
FormatSetType
FormattingType
GradientColorType
GradientDirectionType
GradientFillType
GradientPresetType
GradientStyleType
GridlineType
HeaderFooterCommandType
HtmlCrossType
HtmlExportDataOptions
HtmlFormatHandlingType
HtmlHiddenColDisplayType
HtmlHiddenRowDisplayType
HtmlLinkTargetType
IconSetType
ImageType
InputMethodEditorMode
LabelPositionType
LegendPositionType
LightRigDirectionType
LightRigType
LineCapType
LineJoinType
LineSpaceSizeType
LineType
LoadDataFilterOptions
LoadFormat
LookAtType
LookInType
MapChartLabelLayout
MapChartProjectionType
MapChartRegionType
MemorySetting
MetadataType
MirrorType
MsoArrowheadLength
MsoArrowheadStyle
MsoArrowheadWidth
MsoDrawingType
MsoLineDashStyle
MsoLineStyle
MsoPresetTextEffect
MsoPresetTextEffectShape
NameScopeType
NumberCategoryType
OdsCellFieldType
OdsGeneratorType
OdsPageBackgroundGraphicPositionType
OdsPageBackgroundGraphicType
OdsPageBackgroundType
OLEDBCommandType
OoxmlCompliance
OoxmlCompressionType
OperatorType
PageLayoutAlignmentType
PageOrientationType
PaneStateType
PaperSizeType
ParameterType
PasteOperationType
PasteType
PdfCompliance
PdfCompressionCore
PdfCustomPropertiesExport
PdfFontEncoding
PdfOptimizationType
PivotConditionFormatRuleType
PivotConditionFormatScopeType
PivotFieldDataDisplayFormat
PivotFieldSubtotalType
PivotFieldType
PivotFilterType
PivotGroupByType
PivotItemPosition
PivotMissingItemLimitType
PivotTableAutoFormatType
PivotTableStyleType
PlacementType
PlotDataByType
PlotEmptyCellsType
PresetCameraType
PresetMaterialType
PresetShadowType
PresetWordArtStyle
PrintCommentsType
PrintErrorsType
PrintingPageType
PrintOrderType
PrintSizeType
PropertyType
ProtectionType
QuartileCalculationType
ReConnectionMethodType
RectangleAlignmentType
ReflectionEffectType
RenameStrategy
ResourceLoadingType
RevisionActionType
RevisionType
SaveFormat
SelectionType
ShapeAnchorType
ShapeLockType
ShapePathType
SheetType
ShiftType
ShowDropButtonType
SlicerCacheCrossFilterType
SlicerCacheItemSortType
SlicerStyleType
SmartTagShowType
SortOnType
SortOrder
SparklineAxisMinMaxType
SparklinePresetStyleType
SparklineType
SqlDataType
StyleModifyFlag
TableDataSourceType
TableStyleElementType
TableStyleType
TargetModeType
TextAlignmentType
TextAutonumberScheme
TextCapsType
TextCrossType
TextDirectionType
TextFontAlignType
TextNodeType
TextOrientationType
TextOverflowType
TextStrikeType
TextTabAlignmentType
TextureType
TextVerticalType
ThemeColorType
TickLabelPositionType
TickMarkType
TiffCompression
TimePeriodType
TimeUnit
TotalsCalculation
TrendlineType
TxtLoadStyleStrategy
TxtValueQuoteType
UpdateLinksType
ValidationAlertType
ValidationType
VbaModuleType
VbaProjectReferenceType
ViewType
VisibilityType
WarningType
WebExtensionStoreType
WeightType
XAdESType

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)
           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)
           Specifies the user description for this connection
intgetConnectionId()→ inherited from ExternalConnection
           Specifies The unique identifier of this connection.
intgetCredentials()→ inherited from ExternalConnection
voidsetCredentials(int)
           Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the property is CredentialsMethodType integer constant.
intgetCredentialsMethodType()→ inherited from ExternalConnection
voidsetCredentialsMethodType(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.StringgetEditPage()
voidsetEditPage(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.StringgetEditWebPage()
voidsetEditWebPage(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.
intgetHtmlFormat()
voidsetHtmlFormat(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.
intgetId()→ inherited from ExternalConnection
           Gets the id of the connection.
booleanisConsecutive()
voidsetConsecutive(boolean)
           Flag indicating whether consecutive delimiters should be treated as just one delimiter.
booleanisDeleted()→ inherited from ExternalConnection
voidsetDeleted(boolean)
           Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
booleanisHtmlTables()
voidsetHtmlTables(boolean)
           Flag indicating whether web queries should only work on HTML tables.
booleanisNew()→ inherited from ExternalConnection
voidsetNew(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.
booleanisParsePre()
voidsetParsePre(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.
booleanisSameSettings()
voidsetSameSettings(boolean)
           Flag indicating whether to parse all tables inside a PRE block with the same width settings as the first row.
booleanisTextDates()
voidsetTextDates(boolean)
           Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates.
booleanisXl2000()
voidsetXl2000(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.
booleanisXl97()
voidsetXl97(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.
booleanisXml()
voidsetXml(boolean)
           true if the web query source is XML (versus HTML), otherwise false.
booleanisXmlSourceData()
voidsetXmlSourceData(boolean)
           Flag indicating that XML source data should be imported instead of the HTML table itself.
booleangetKeepAlive()→ inherited from ExternalConnection
voidsetKeepAlive(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.StringgetName()→ inherited from ExternalConnection
voidsetName(java.lang.String)
           Specifies the name of the connection. Each connection must have a unique name.
java.lang.StringgetOdcFile()→ inherited from ExternalConnection
voidsetOdcFile(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.
booleangetOnlyUseConnectionFile()→ inherited from ExternalConnection
voidsetOnlyUseConnectionFile(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
ConnectionParameterCollectiongetParameters()→ inherited from ExternalConnection
           Gets ConnectionParameterCollection for an ODBC or web query.
java.lang.StringgetPost()
voidsetPost(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.PowerQueryFormulagetPowerQueryFormula()→ inherited from ExternalConnection
           Gets the definition of power query formula.
intgetReconnectionMethod()→ inherited from ExternalConnection
voidsetReconnectionMethod(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.
intgetReconnectionMethodType()→ inherited from ExternalConnection
voidsetReconnectionMethodType(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.
intgetRefreshInternal()→ inherited from ExternalConnection
voidsetRefreshInternal(int)
           Specifies the number of minutes between automatic refreshes of the connection.
booleangetRefreshOnLoad()→ inherited from ExternalConnection
voidsetRefreshOnLoad(boolean)
           True if this connection should be refreshed when opening the file; otherwise, false.
booleangetSaveData()→ inherited from ExternalConnection
voidsetSaveData(boolean)
           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)
           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)
           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)
           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)
           Gets or Sets the external connection DataSource type. The value of the property is ConnectionDataSourceType integer constant.
java.lang.StringgetUrl()
voidsetUrl(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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.