OlapProperties Class
OLAP Properties.When the object is serialized out as xml, its qualified name is x:olapPr.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Spreadsheet.OlapProperties
Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class OlapProperties _
Inherits OpenXmlLeafElement
'Usage
Dim instance As OlapProperties
public class OlapProperties : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
18.13.5 olapPr (OLAP Properties)
This element contains all the properties needed for an OLAP data connection. OLE DB for OLAP is the data provider, and OLAP connections contain both the dbPr and olapPr child elements.
[Example:
Data connectivity can use a number of different technologies. The following is an example of a connection to an SAP BW OLAP data source:
<connection id="1" odcFile="C:\My Documents\My Data Sources\$INFOCUBE.odc" keepAlive="1" name="SAP demo cube" description="SAP DemoCube" type="5" refreshedVersion="3" background="1"> <dbPr connection="Provider=MDrmSap.2;Data Source=BI2;User ID=TESTUSER;Location=TESTSERVERNAME;Cache Authentication=False;Encrypt Password=False;Integrated Security="";Mask Password=False;Persist Encrypted=False;Persist Security Info=True;Impersonation Level=Anonymous;Mode=Read;Protection Level=None;Extended Properties="SFC_CLIENT=800;";Initial Catalog=$INFOCUBE" command="$0D_DECU" commandType="1"/> <olapPr sendLocale="1" rowDrillCount="1000" serverFill="0" serverNumberFormat="0" serverFont="0" serverFontColor="0"/> </connection>
end example]
[Example:
Data connectivity can use a number of different technologies. The following is an example of a connection to a Microsoft SQL Server Analysis Services OLAP data source:
<connection id="1"
odcFile="C:\My Documents\My Data Sources\Adventure Works DW.odc" keepAlive="1"
name="Adventure Works DW" type="5" refreshedVersion="3" background="1">
<dbPr connection="Provider=MSOLAP.3;Cache Authentication=False;Persist Security Info=True;Initial Catalog=Adventure Works
DW;Data Source=DATASERVER1;Impersonation
Level=Impersonate;Mode=ReadWrite;Protection Level=Pkt Privacy;Auto Synch
Period=20000;Default Isolation Mode=0;Default MDX Visual Mode=0;MDX
Compatibility=1;MDX Unique Name Style=0;Non Empty
Threshold=0;SQLQueryMode=Calculated;Safety Options=2;Secured Cell
Value=0;SOURCE_DSN_SUFFIX="Prompt=CompleteRequired;Window
Handle=0x6A903CC;";SQL Compatibility=0;Compression Level=0;Real Time
Olap=False;Packet Size=4096" command="Adventure Works" commandType="1"/>
<olapPr sendLocale="1" rowDrillCount="1000"/>
</connection>
end example]
[Note: Data connectivity can use a number of different technologies. One example of potential values stored in this attribute can be found at https://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/dasdkoledboverview.asp end note]
Parent Elements |
|---|
connection (§18.13.1) |
Attributes |
Description |
|---|---|
local (Local Cube) |
Flag indicating whether we should get data from the local cube on refresh versus the original data source. true if a local cube has been created for OLAP data, and it should be used instead of the server. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
localConnection (Local Cube Connection) |
Specifies a connection string to use when a local cube is available. This is used when local is set to true. [Example: <olapPr local="true" localConnection="OLEDB;Provider=MSOLAP;Data Source=C:\Data\DataCube.cub" > end example] The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
localRefresh (Local Refresh) |
Flag indicating whether we should refresh the local cube from the original data source. When true, the original OLAP data source is queried each time the user explicitly refreshes the data in the application, and a new local cube is constructed from this query. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
rowDrillCount (Drill Through Count) |
Maximum number of drill-through rows to return when the user drills through an aggregate value in a PivotTable. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
sendLocale (Send Locale to OLAP) |
When true, the spreadsheetML app should send the user interface locale ID to the OLAP provider to retrieve localized member names and properties, etc. When false, no locale ID is expected. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
serverFill (OLAP Fill Formatting) |
When true a PivotTable based on an OLAP source should format the data and aggregate cells in the PivotTable view using the background color from the OLAP source if this information is available. When false, OLAP server background fill colors are ignored, and standard formatting rules within the worksheet are followed. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
serverFont (OLAP Server Font) |
When true, a PivotTable based on OLAP source should format the data and aggregate cells in the PivotTable view using the font from the OLAP source (e.g., Arial or Tahoma). When false, OLAP server fonts are ignored, and standard formatting rules within the worksheet are followed. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
serverFontColor (OLAP Font Formatting) |
When true a PivotTable based on OLAP source should format the data and aggregate cells in the PivotTable view using the font color from the OLAP source. When false, OLAP server font colors are ignored, and standard formatting rules within the worksheet are followed. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
serverNumberFormat (OLAP Number Format) |
When true, a PivotTable based on OLAP source should format the data and aggregate cells in the PivotTable view using the number format from the OLAP source. When false, OLAP server number formats are ignored, and standard formatting rules within the worksheet are followed. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
[Note: The W3C XML Schema definition of this element’s content model (CT_OlapPr) is located in §A.2. end note]
© ISO/IEC29500: 2008.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.