CubeField Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a hierarchy or measure field from an OLAP cube.
public interface class CubeField[System.Runtime.InteropServices.Guid("0002444C-0000-0000-C000-000000000046")]
public interface CubeFieldPublic Interface CubeField- Attributes
Remarks
In a PivotTable report, the CubeField object is a member of the CubeFields collection.
Use the CubeField property to return the CubeField object.
Use CubeFields(index), where index is the cube field’s index number, to return a single CubeField object.
Properties
| _Caption |
Returns a String value that represents the label text for the cube field. |
| AllItemsVisible |
The AllItemsVisible property checks whether manual filtering is applied to a PivotField or CubeField. Read-only Boolean. |
| Application |
When used without an object qualifier, this property returns an Application object that represents the Microsoft Excel application. When used with an object qualifier, this property returns an Application object that represents the creator of the specified object (you can use this property with an OLE Automation object to return the application of that object). Read-only. |
| Caption |
The label text for the cube field. |
| Creator |
Returns a 32-bit integer that indicates the application in which this object was created. |
| CubeFieldSubType |
Specifies the type of a CubeField. Read-only. |
| CubeFieldType |
Indicates whether the OLAP cube field is a hierarchy field or a measure field. |
| CurrentPageName |
Returns or sets the page name for a CubeField. Read/write String. |
| DragToColumn |
True if the specified field can be dragged to the column position. |
| DragToData |
True if the specified field can be dragged to the data position. |
| DragToHide |
True if the field can be hidden by being dragged off the PivotTable report. |
| DragToPage |
True if the field can be dragged to the page position. |
| DragToRow |
True if the field can be dragged to the row position. |
| EnableMultiplePageItems |
True to allow multiple items in the page field area for OLAP PivotTables to be selected. |
| FlattenHierarchies |
Gets or sets whether items from all levels of hierarchies in a named set cube field are displayed in the same field of a PivotTable report based on an OLAP cube. |
| HasMemberProperties |
Returns True when there are member properties specified to be displayed for the cube field. |
| HiddenLevels |
Returns or sets the top levels of the specified hierarchy that are hidden. |
| HierarchizeDistinct |
Gets or sets whether to order and remove duplicates when displaying the specified named set in a PivotTable report based on an OLAP cube. |
| IncludeNewItemsInFilter |
The IncludeNewItemsInFilter property is used to track included/excluded items in OLAP PivotTables. Read/write. |
| IsDate |
Returns True if the CubeField is a date. Read-only Boolean. |
| LayoutForm |
Returns or sets the way the specified PivotTable items appear — in table format or in outline format. |
| LayoutSubtotalLocation |
Returns or sets the position of the PivotTable field subtotals in relation to (either above or below) the specified field. |
| Name |
Returns the name of the object. |
| Orientation |
The location of the field in the specified PivotTable report. |
| Parent |
Returns the parent object for the specified object. |
| PivotFields |
Returns the PivotFields collection. This collection contains all PivotTable fields, including those that aren’t currently visible on-screen. |
| Position |
Position of the item in its field if the item is currently showing. |
| ShowInFieldList |
When set to True (default), a CubeField object will be shown in the field list. |
| TreeviewControl |
Returns the TreeviewControl object, representing the cube manipulation control of an OLAP-based PivotTable report. |
| Value |
Returns the name of the specified field. |
Methods
| AddMemberPropertyField(String, Object) |
Adds a member property field to the display for the cube field. |
| AddMemberPropertyFieldEx(String, Object, Object) |
Reserved for internal use. |
| ClearManualFilter() |
The ClearManualFilter() method provides an easy way to set the Visible property to True for all items of a PivotField in PivotTables, and to empty the HiddenItemsInList/VisibleItemsList collections in OLAP PivotTables. |
| CreatePivotFields() |
The CreatePivotFields() method is new in Microsoft Office Excel 2007. It enables users to apply a filter to PivotFields not yet added to the PivotTable by creating the corresponding PivotFieldobject. |
| Delete() |
Deletes the object. |