DimensionInclude Property

Applies To

CustomView Object

Discussion

Each CustomView object automatically includes a collection of View objects: one for each dimension. The default view for each object in a collection is 'All Categories'. Use this property to omit all categories or create a custom view.

When you set this property, you must include a Dimension object as a parameter. This parameter specifies the dimension to which the view applies.

To define a view so that all categories in a dimension are omitted from a cube, set this property to trViewTypeOmitDimension.

Custom views provide a specific subset of cube information to PowerPlay® users. A custom view may summarize an entire level or individual categories within the level. If you specify a custom view (trViewTypeCustom), you must also use the DimensionView property to return the View object associated with a Dimension. You can then use the Apex property to create a new root category, or the SetViewStatus method to associate the View object with selected levels or categories.

To complete a custom view, you must associate a custom view with a cube. Use the Add method to add a CustomView object to the CubeCustomViews collection of the cube.

The DimensionInclude property returns a constant from the xtrViewType value list.

A COM exception is thrown in error situations. The message that is passed with the exception varies depending on the error situation.

Type

Constant - xtrViewType

Access

Read/Write