2.4.58 BrtBeginECOlapProps

Office

The BrtBeginECOlapProps record specifies the properties of an OLAP connection (section 2.2.8.3.1) and specifies the beginning of an empty collection of records as defined by the External Data Connections (section 2.1.7.24) part ABNF. The properties that specify server formatting options are used to specify whether server formatting retrieved from the OLAP data source is applied to the cells used by PivotTables (section 2.2.5) or cube functions associated with the PivotCache (section 2.2.5.2) that is associated with the external connection (section 2.2.8), as specified in section 2.2.5.2.1. In the case of PivotTables, the formatting is applied to the cells in data area (section 2.2.5.3.8.1.4) of the PivotTable report. In the case of cube functions, the formatting is applied to the cells that contain the result of the cube function. When a local cube file is used, as specified by fLocalConn, the OLE DB for OLAP data provider is used to connect to a file, which is a cache of the OLAP data source.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

A

B

C

D

E

F

G

H

nDrillthroughRows

...

I

reserved2

stConnLocal (variable)

...

A - fLocalConn (1 bit): A bit that specifies whether data is retrieved from a local cube file. This value MUST be one of the values in the following table.

Value

Meaning

0

The data is retrieved using the connection string specified by the stConn field of the BrtBeginECDbProps (section 2.4.57) record preceding this record.

1

The data is retrieved from the connection string specified by stConnLocal.

B - fNoRefreshCube (1 bit): A bit that specifies whether the OLE DB for OLAP data provider is requested to rebuild the local cube file. This value is applicable only when fLocalConn is equal to 1. This value MUST be one of the values in the following table.

Value

Meaning

0

The OLE DB for OLAP data provider is requested to rebuild the local cube file on refresh.

1

The OLE DB for OLAP data provider is requested to query the existing local cube file on refresh.

C - fSrvFmtBack (1 bit): A bit that specifies whether the background color retrieved from the OLAP data source is used for cell formatting. This value MUST be one of the values in the following table.

Value

Meaning

0

Fill colors retrieved from the OLAP data source are ignored.

1

Fill colors retrieved from the OLAP data source are used for cell formatting.

D - fSrvFmtFore (1 bit): A bit that specifies whether the font face color retrieved from the OLAP data source is used for cell formatting. This value MUST be one of the values in the following table.

Value

Meaning

0

Font colors retrieved from the OLAP data source are ignored.

1

Font colors retrieved from the OLAP data source are used for cell formatting.

E - fSrvFmtFlags (1 bit): A bit that specifies whether the font family name retrieved from the OLAP data source is used for cell formatting. This value MUST be one of the values in the following table.

Value

Meaning

0

Font family names retrieved from the OLAP data source are ignored.

1

Font family names retrieved from the OLAP data source are used for cell formatting.

F - fSrvFmtNum (1 bit): A bit that specifies whether the format string retrieved from the OLAP data source is used for cell formatting. This value MUST be one of the values in the following table.

Value

Meaning

0

Formats strings retrieved from the OLAP data source are ignored.

1

Formats strings retrieved from the OLAP data source are used for cell formatting.

G - fUseOfficeLcid (1 bit): A bit that specifies whether the language code identifier (LCID) is sent to the OLE DB for OLAP data provider to retrieve data in a localized manner.

H - reserved1 (1 bit): This value MUST be 0, and MUST be ignored.

nDrillthroughRows (4 bytes): A DRw (section 2.5.34) that specifies the maximum number of drillthrough rows to return when the user drills through an aggregate value in a PivotTable (section 2.2.5). This value MUST be greater than 0 and less than 1048577.

I - bLoadConnLocal (1 bit): A bit that specifies whether stConnLocal exists after the fixed size portion of the record. This value MUST be 1 if fLocalConn is 1.

reserved2 (7 bits): This value MUST be 0, and MUST be ignored.

stConnLocal (variable): An optional XLWideString (section 2.5.168) that specifies a connection string to use when a local cube file is available. This field MUST exist if and only if bLoadConnLocal is 1. The length of this value MUST be less than 65536.

Show: