Class ExternalSourceInfoRecord

This record stores information about the SQL query string that retrieves external data for a PivotTable. The record is followed by SXSTRING records that contain the SQL strings and then by a SXSTRING record that contains the SQL server connection string.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
ExternalSourceInfoRecord
Implements
System.ICloneable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.ExternalSourceInfo)]
[CLSCompliant(false)]
public class ExternalSourceInfoRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

ExternalSourceInfoRecord()

Default constructor.

Declaration
public ExternalSourceInfoRecord()

ExternalSourceInfoRecord(Int32)

Reserved for record's internal data array.

Declaration
public ExternalSourceInfoRecord(int iReserve)
Parameters
Type Name Description
System.Int32 iReserve

Amount of bytes for the data array.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

If amount of bytes requested is less than zero.

ExternalSourceInfoRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public ExternalSourceInfoRecord(Stream stream, out int itemSize)
Parameters
Type Name Description
System.IO.Stream stream

Stream from which record data should be read.
System.Int32 itemSize

Size of read item.
Exceptions
Type Condition
System.ArgumentNullException

When stream is not specified.
System.ApplicationException

When stream does not support read or seek operations.

Properties

DataSourceType

1 - ODBC data source, 2 - DAO recordset (no actual information about the recordset is saved), 3 - reserved, 4 - Web (WWW) query.

Declaration
public ushort DataSourceType { get; set; }
Property Value
Type
System.UInt16

IsOdbcConnection

True for ODBC connection.

Declaration
public bool IsOdbcConnection { get; set; }
Property Value
Type
System.Boolean

IsSavePassword

Indicates whether save password option is on.

Declaration
public bool IsSavePassword { get; set; }
Property Value
Type
System.Boolean

IsSql

True for SQL statement or URL.

Declaration
public bool IsSql { get; set; }
Property Value
Type
System.Boolean

IsSqlSav

True for server-based page fields.

Declaration
public bool IsSqlSav { get; set; }
Property Value
Type
System.Boolean

IsTablesOnlyHtml

Indicates whether save tables in HTML only option is on.

Declaration
public bool IsTablesOnlyHtml { get; set; }
Property Value
Type
System.Boolean

IsWeb

True for Web (WWW) query.

Declaration
public bool IsWeb { get; set; }
Property Value
Type
System.Boolean

OdbcConnectionCount

Number of strings for ODBC connection string.

Declaration
public ushort OdbcConnectionCount { get; set; }
Property Value
Type
System.UInt16

Options

Options flags. Read-only.

Declaration
public ushort Options { get; }
Property Value
Type
System.UInt16

ParamsCount

Number of parameter strings.

Declaration
public ushort ParamsCount { get; set; }
Property Value
Type
System.UInt16

QueryCount

Number of strings for SQL statement or URL.

Declaration
public ushort QueryCount { get; set; }
Property Value
Type
System.UInt16

SQLSavCount

Number of strings for SQL statement for server-based page fields.

Declaration
public ushort SQLSavCount { get; set; }
Property Value
Type
System.UInt16

WebPostCount

Number of strings for post method of Web query.

Declaration
public ushort WebPostCount { get; set; }
Property Value
Type
System.UInt16

Methods

GetStoreSize(ExcelVersion)

Evaluates size of the required storage space.

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type Description
System.Int32

Size of the required storage space.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Converts data buffer to special values according to record specification.

Declaration
public override void ParseStructure(DataProvider provider, int iOffset, int iLength, ExcelVersion version)
Parameters
Type Name Description
DataProvider provider

Object that provides access to the data.
System.Int32 iOffset

Offset to the record's data.
System.Int32 iLength

Length of the record's data.
ExcelVersion version

Excel version used for infill.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

Implements

System.ICloneable