Below is a list of all the variables that can be set via the GetValue and SetValue methods.
The easiest way to see how to set these variables is to create a view file and open it with a text file. It would be apparent what to do.
Please use for Boolean values: 0 for False and -1 for True.
The use of upper or lower case
letters is indistinct in variable names.
|
| Layout settings.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| Move
|
|
| Boolean
| Drill
| Specifies to exchange
dimension when a drill
action is made.
|
| Anidate
|
|
| Boolean
| Drill
| Anidate dimensions to a
cube axis when a drill
action is made.
|
| From
|
|
| Number
| Drill
| Specifies the header
dimension number in a drill action is made.
|
| Row
|
|
| Number
| Drill
| Sets a click on a row in
the data grid. The top row is zero.
|
| Col
|
|
| Number
| Drill
| Sets a click on a column
in the data grid. The left column is zero.
|
| Interactive
|
|
| Boolean
|
| Sets whether the user can
interact with the control, or the control only shows cube data.
|
| General settings.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| CurrSequence
|
|
| Number
|
| Specifies the sequence
number to jump in a doAction("moveSequence") operation
|
| NumCube
|
|
| Numeric
|
| Specifies the cube number
inside a MS Analysis Services database. Use 0 for local cubes.
|
| FileNameSave
|
|
| Character
| SaveView
| Sets the file name to
save cube views.
|
| DirNameSave
|
|
| Character
| SaveView
| Sets the directory name to save cube views. Must finish with '\'. The final file
name is directory + file.
|
| FileNameExport
|
|
| Character
| ExportView
| Sets the file name to
export cube views.
|
| DirNameExport
|
|
| Character
| ExportView
| Sets the directory name to export cube views. Must finish with '\'. The final file name is directory +
file.
|
| FileNamePortfolio
|
|
| Character
|
| Sets the default
portfolio file name to
save.
|
| DirNamePortfolio
|
|
| Character
|
| Sets the default
portfolio directory
name to save. Must
finish with '\'. The final file name is directory + file.
|
| FormEnabled
|
|
| Boolean
|
| Enables or disables the
control.
|
| LanguageId
|
|
| Number
|
| Sets the control
language.
| 0
| English
|
| 1
| Spanish
|
| 2
| Portuguese |
|
| OpenLayout
|
|
| Boolean
|
| Use a False (0) value if
you want to open cubes directly, use True (-1) if you want to open
the cubes in layout mode.
|
| OpenCurrentCube
|
|
| Boolean
|
| Specifies whether to open
the default cube or not. Set to False (-1) if you don't want to open
the default cube set in the Preferences dialog.
|
| OpenServer
|
|
| Character
|
| Specifies a MS Analysis
Services to connect to. Call DoAction("OpenParam") to connect.
|
| OpenUser
|
|
| Character
|
| Specifies the user to
connect to MS Analysis Services. Call DoAction("OpenParam") to connect.
|
| OpenPassword
|
|
| Character
|
| Specifies the password to
connect to MS Analysis Services. Call DoAction("OpenParam") to connect.
|
| OpenDb
|
|
| Character
|
| Specifies the MS Analysis
Services database to connect to. Call DoAction("OpenParam") to connect.
|
| OpenCube
|
|
| Character
|
| Specifies the MS Analysis
Services cube to connect to. Call DoAction("OpenParam") to connect.
|
| OpenFile
|
|
| Character
|
| Specifies a local cube
file to connect to. Call DoAction("OpenParam") to connect.
|
| OpenWWWDir
|
|
| Character
|
| Specifies a cube, view or
portfolio file situated on a web site to connect to. Call DoAction("OpenParam") to
connect.
|
| OpenView
|
|
| Character
|
| Specifies a local view to
connect to. Call DoAction("OpenParam") to connect.
|
| OpenPortfolio
|
|
| Character
|
| Specifies a portfolio
file to connect to. Call DoAction("OpenParam") to connect.
|
| RefreshTimerValue
|
|
| Number
|
| Specifies the time in
minutes to call the RefreshTimer action.
|
| RefreshTimerActive
|
|
| Boolean
|
| Turns on or off the RefreshTimer action.
|
| MDX
|
|
| Character
|
| Sets o retrieves a cube
query to execute. Call action ExecuteMDX to execute it.
|
| Caption
|
|
| Character
|
| Sets or retrieves the
cube title.
|
| EmptyHorizontal
|
|
| Boolean
|
| Specifies whether to show
empty rows or not in the data grid.
|
| EmptyVertical
|
|
| Boolean
|
| Specifies whether to show
empty columns or not in the data grid.
|
| FormulaListSide
|
|
| Boolean
|
| Specifies whether to show
a list formula in grid or not.
|
| FormulaListChart
|
|
| Boolean
|
| Specifies if the list
formulas will be shown in the chart or not.
|
| MaxPointsPerPage
|
|
| Number
|
| Sets the maximum number
of points to print in a "page" chart. Set to 0 to show all points in
the chart.
|
| ChartShowSubtotals
|
|
| Boolean
|
| Use True (-1) if you want
to show dimension elements with their children, for example
Customers.Total with individual customers. Otherwise use False (0).
|
| ChartDefaultLoad (Deprecated)
|
|
| Boolean
|
| Set to True (-1) if you
want a chart file to load with default chart settings.
Note:
You can use the preferences dialog to load a
new chart file or reset the chart with the current chart. The chart
is saved in the windows registry.
|
| ChartDefaultFile(Deprecated)
|
|
| Character
|
| Chart name file to use if
ChartDefaultLoad is set to True (-1). See note above .
|
| ViewSaveLayout (Deprecated)
|
|
| Boolean
|
| Set to False (0) if you
don't want to set the cube layout with each view or portfolio.
|
| ViewGridLayout (Deprecated)
|
|
| Boolean
|
| Set to False (0) if you
don't want to set the grid layout options with each view or
portfolio.
|
| ViewGridOptions (Deprecated)
(Deprecated)
|
|
| Boolean
|
| Set to False (0) if you
don't want to set the grid format options with each view or
portfolio.
|
| PortfolioMode
|
|
| Boolean
|
| Set to True (-1) if you
want to show portfolios in portfolio mode or not.
|
| PortfolioTimer
|
|
| Boolean
|
| Set to True (-1) if you
want to set the portfolio timer when showing the portfolio.
|
| PortfolioTime
|
|
| Number
|
| Number of seconds to wait
between changing pages when showing the portfolio with the timer set
on.
|
| Print1SlideXFile
|
|
| Boolean
|
| Sets wether you want to export your portfolio to one file or each page to one distinct file.
|
| PortfolioSlide |
|
|
Number |
GotoPortfolio |
Sets the portfolio page to jump to. |
| AutoRefreshCube
|
|
| Boolean
|
| Refreshes the cube data each time the cube is queried.
|
| GridLayoutRead
|
|
| Boolean
|
| Cube visible parts and
their position are read from views and portfolios.
|
| GridLayoutWrite
|
|
| Boolean
|
| Cube visible parts and their position are written into views and portfolios.
|
| GridOptionsRead
|
|
| Boolean
|
| Grid options (fonts,
colors, etc.) are read from views and portfolios.
|
| GridOptionsWrite
|
|
| Boolean
|
| Grid options (fonts,
colors, etc.) are written into views and portfolios.
|
| PageSetupRead
|
|
| Boolean
|
| Page setup information
(templates, logo, etc.) are read from views and portfolios.
|
| PageSetupWrite
|
|
| Boolean
|
| Page setup information
(templates, logo, etc.) are written into views and portfolios.
|
| PreferencesRead
|
|
| Boolean
|
| Global cube preferences are read from views and portfolios.
|
| PreferencesWrite
|
|
| Boolean
|
| Global cube preferences are written into views and portfolios.
|
| ChartCustomTitle
|
|
| Boolean
|
| Let's you change the
chart header and set it
different than the cube view caption.
|
| InvalidNumber
|
|
| Character
| InvalidNumber
| When the database returns
an invalid number, you can print it as a specific string value. Use
"---" for the normal behaviour.
|
| InvalidNumberFlag |
|
|
Boolean |
|
Set this value to true to print raw
database values. |
| Batch settings.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| Batch
|
|
| Boolean
| Batch
| Sets the control
processing to bacth mode. This way you can use the control from with
ASP, VBScript or JavaScript in background mode.
|
| AskOverwrite
|
|
| Boolean
| Batch
| If set to true, you won't
be asked if you want to overwrite an existing file. Is useful in
batch processing.
|
| FileTypeExport
|
|
| Numeric
| Batch
| Specifies the file type
when exporting views in batch mode:
| 1
| htm file
|
| 2
| rtf file (Word)
|
| 3
| pdf file (Acrobat)
|
| 4 or other
| csv file
(Excel) |
|
| PrintAll
|
|
| Boolean
| Batch
| Specifies wether to print
or copy all cube query data or just the visible screen.
| True
| Visible screen
|
| False
| All query
data |
|
| Dimension
settings.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| NumDims
|
|
| Number
|
| Retrieves or specifies
the number of dimensions in a cube.
|
| InitOrderDim
| Dimension #
|
| Number
|
| Initializes the
dimensions structure. Call it before other dimension variables.
|
| Hierarchy
| Dimension #
|
| Number
|
| Sets the dimension
hierarchy type. Use the OlapXDimHierarchy enum to set dimension
types:
| 0
| Explorer mode
|
| 1
| Hierarchy mode
|
| 2
| List
|
| 3
| Final nodes
|
| 4
| Complete hierarchy
|
| 5
| Only me
|
| 6
| Only my sons
|
| 7
| Level mode
|
| 8
| Dimension is in heading
area only |
|
| HierarchyJump
| Dimension #
|
| Number
|
| Sets the dimension jump
for the hierarchy mode.
|
| Place
| Dimension #
|
| Number
|
| Sets the dimension place
in the control.
Use the OlapXDimPlace enum to set dimension
types:
| 0
| Heading area
|
| 1
| Horizontal axis
|
| 2
| Vertical
axis |
|
| Name
| Dimension #
|
| Number
|
| Dimension name.
|
| Depth
| Dimension #
|
| Number
|
| Dimension depth in
hierarchy mode.
|
| Type
| Dimension #
|
| Number
|
| Dimension type.
Use the OlapXDimType enum to set dimension
types:
| 0
| Time dimension
|
| 1
| Measures dimension
|
| 2
| Normal
dimension |
|
| Show
| Dimension #
|
| Boolean
|
| True for showing the
dimension in the heading area.
|
| LevelProperties
| Dimension #
|
| Character string
| "OlapX%Name||
OlapX%Name" for
2 level
hierarchy
| String with these
dimension level properties.
|
| LevelDepth
| Dimension #
|
| Number
|
| Dimension number of
levels.
|
| FormulaList
| Dimension #
|
| Character
| |0|1|2|3|4|
| List of formulas to show
when showing a list of dimension fields. The list is separated by
pipes "|". Use:
| 0
| Total
|
| 1
| Average
|
| 2
| Minimum
|
| 3
| Maximum
|
| 4
| Count records
|
| 5
| Median
|
| 6
| Standard deviation
|
| 7
| Variance |
|
| FormulaOnlyMe
| Dimension #
|
| Character
| |0|1|2|3|4|
| List of formulas to show
when showing only one field. The list is separated by pipes "|".
Use:
| 0
| Values
|
| 1
| % Total
|
| 2
| % Parent
|
| 3
| Ranking
|
| 4
| Best
|
| 5
| Increment
|
| 6
| Decrement
|
| 7
| Difference
|
| 8
| Year to date
|
| 9
| Rolling sum
|
| 10
| Rolling
average |
|
| Order
| Dimension #
|
| Number
|
| Order of dimension in the
axis. Begins with 0.
|
| KeyFatherNum
| Dimension #
|
| Number
|
| Number of members in
dimension. For list hierarchy is the number of members, otherwise is
one.
|
| KeyFather
| Dimension #
| Parent #
| Character
|
| Add a unique member of a
dimension. Adds as many elements as needed for list hierarchy mode.
|
| FatherTextNum
| Dimension #
|
| Number
|
| Number of members in
dimension. For list hierarchy is the number of members, otherwise is
one.
|
| FatherText
| Dimension #
| Parent #
| Character
|
| Add a display parent of a
dimension. Adds as many elements as needed for list hierarchy mode.
|
| CalcFieldsNum
| Dimension #
|
| Number
|
| Number of calculated
fields defined for this dimension.
|
| CalcFields
| Dimension #
| Calc field #
| Character
| name, format,
solve
order, text
| Add a dimension
calculated field. This is a string separated with commas. Use:
| name
| Name of the formula.
Change commas with "{}".
|
| format
| Output format. See
DataFormat below.
|
| solve order
| Solve order of the
formula. It's the order in which the formulas are executed.
|
| text
| MDX instruction that
defines the field. Change commas with "{}". |
|
| DrillStateNum
| Dimension #
|
| Number
|
| Number of dimension
fields that are in the drill state collection.
|
| DrillState
| Dimension #
| Field #
| Character
|
| Unique dimension field
names that define are drilled down or up on dimension with explorer
mode hierarchy.
|
| HierarchyUsed
| Dimension #
|
| Number
|
| Number of records of
level information to show/hide exists for this dimension
|
| LevelDefaultsNum
| Dimension #
|
| Number
|
|
|
| LevelDefaults
| Dimension #
| Level #
| Character
| 0,1,-1,,
| Keeps information wether
to show or hide this level when displaying it. The list of values
are:
| hierarchy
| Number of hierarchy within
the dimension.
|
| level
| Number of level within the
hierarchy.
|
| show
| Marks wether to show or
hide this level. Use -1 for "Show this level", 0 to "Hide
this level".
|
| name
| Reserved for future
use. It's ignored.
|
| UniqueName
| Reserved for future
use. It's ignored. |
|
| Cube options.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| RotateWithCube
|
|
| Boolean
|
| Specifies whether to
rotate the cube options with axis swapping in the data grid.
|
| Cube options:
Value
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| FormulaAxis
|
|
| Boolean
|
| Specifies whether to
apply this formula in the horizontal or vertical cube axis. This
field is of type OlapXDimPlace, and you can use:
| 1
| Horizontal axis
|
| 2
| Vertical
axis |
|
| FormulaField
|
|
| Character
| [Measures].[Profits]
| Is the field against
which will be applied the formula you want to display. You want to
choose the percent of parent of a field against his parent.
|
| FormulaLevel
|
|
| Character
| [Customer].[Country]
| For the Best formula, you choose which level
dimension fields you want to bring.
|
| FormulaName
|
|
| Character
|
| Keeps the name of the
formula chosen in FormulaType.
|
| FormulaShowDim
|
|
| Number
|
| Specifies how to choose
the dimensions in the dialog. Use:
| 0
| No values
|
| 1
| Measures
|
| 2
| All |
|
| FormulaType
|
|
| Number
|
| Specifies the formula
that will be used to show the values. You can use one of the
following values:
| 0
| Values
|
| 1
| % Total
|
| 2
| % Parent
|
| 3
| Ranking
|
| 4
| Best
|
| 5
| Increment
|
| 6
| Decrement
|
| 7
| Difference
|
| 8
| YearToDate
|
| 9
| Rolling Sum
|
| 10
| Rolling
Average |
|
| FormulaValue
|
|
| Number
| ShowCubeView
| Specifies the number of
Rolling Sum and Rolling Average periods.
|
| Cube options:
Order (use 0 for horizontal axis, 1 for vertical axis, no
number depends on OrderAxis value)
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| OrderAxis[01]
|
|
| Number
|
| Chooses the axis in which
the order function will apply. See FormulaAxis for values.
|
| OrderShowDim[01]
|
|
| Number
|
| Specifies how to choose
the dimension in the dialog. Use:
| 0
| No values
|
| 1
| Measures
|
| 2
| All |
|
| OrderType[01]
|
|
| Number
|
| Specifies either
ascending or descending sort. The fields is of type OlapXSortFlag, and available options
are:
| 0
| Dimension order (by
dimension fields and not values)
|
| 1
| Ascending value
|
| 2
| Descending
value |
|
| OrderChooseType[01]
|
|
| Number
|
| Specifies how to choose
fields in the Order tab in the cube options dialog. See above FormulaChooseType for
available values.
|
| OrderFieldsNum[01]
|
|
| Number
| [Time].[1997]
| Initializes the structure
that holds the fields
you are sorting on. Call before OrderField.
|
| OrderField[01]
| order field #
|
| Character
|
| Adds a new order field.
You can choose by as many fields as you want. Either visible or not.
For example show 1998 values sorted by 1997 values.
|
| Cube options:
Pareto (use 0 for horizontal axis, 1 for vertical axis, no
number depends on ParetoAxis value)
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| ParetoAxis[01]
|
|
| Number
|
| Chooses the axis in which
the pareto option function will apply. See FormulaAxis for values.
|
| ParetoField[01]
|
|
| Character
| [Time].[1997]
|
Depecrated.
The value of the cube cells for this
dimension fields, will be used to get the top or bottom records.
For example, you can choose to display product
values for this year, but getting only the top 5 products of last
year.
|
| ParetoFieldNum[01]
|
|
| Numeric
|
| The number of pareto
fields. You can have as many as needed.
|
| ParetoFields[01]
| field #
|
| Character
| [Time].[1997]
| A value of the cube
cells for this dimension fields, will be used to get the top or
bottom records.
For example, you can choose
to display product values for this year, but getting only the top 5
products of last year.
|
| ParetoRegType[01]
|
|
| Number
|
| Specifies to choose
either top values or bottom values. It's type is OlapXParetoRegType, and you can use:
| 0
| Top values
|
| 1
| Bottom
values |
|
| ParetoShowDim[01]
|
|
| Number
|
| Specifies how to choose
the dimension in the dialog. Use:
| 0
| No values
|
| 1
| Measures
|
| 2
| All |
|
| ParetoType[01]
|
|
| Number
|
| Defines the pareto option
to apply. This variable is of OlapXParetoOption type. You can use:
| 0
| Show all elements
|
| 1
| Show a specific number of
records
|
| 2
| Show up to a specific sum
of values
|
| 3
| Show up to a specific
percent of the total value |
|
| ParetoValue[01]
|
|
| Number
|
| This is the value that
will be used to get the top or bottom records. It counts the number of records to
retrieve, a value sum or a percentage value.
|
| ParetoChooseType[01]
|
|
| Number
|
| Specifies how to choose
fields in the Pareto tab in the cube options dialog. See above FormulaChooseType for
available values.
|
| Cube options:
Filter (use 0 for horizontal axis, 1 for vertical axis, no
number depends on FilterAxis value)
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| FilterAxis[01]
|
|
| Number
|
| Chooses the axis in which
the filter option function will apply. See FormulaAxis for values.
|
| FilterNum[01]
|
|
| Number
|
| Initializes the filter
structure. Call before Filter
|
| Filter[01]
| Filter #
| 1,0,
[Measures].[Sales_1]
,> Greater than,
0,[Measures].[Sales_2]
,0,0,0
| Character
|
| Specifies one of multiple
filters to when retrieving cube data.
The
filter is specified by a character string separated by commas, where
each part represents:
| Part name
| Type
|
|
| Left parenthesis
| Boolean
| Use -1 to specify a left
parenthesis for this condition. This parenthesis is used to
join another conditions with Ands and Ors.
|
| Fields to compare
| Character
| Is a list of fields use to
compare against a value or other fields. Replace commas with
{}.
|
| Operator
| Character
| It's the operator that
will be used in comparison instruction. Please use one of
these:
- = Equal to
- > Greater than
- >= Greater or equal to
- < Less than
- <= Less or equal to
- <> Is not equal
The
operator names are not important, but when you save views, the
get into the file.
|
| Value
| Number
| Value to compare to.
|
| Fields to compare
| Character
| You can also compare
against a field value. If it is defined, the field will be
used regardless of the value to the left. Replace commas with
{}.
|
| Join previous
| Boolean
| Use -1 if this condition
and the last are joined together with an OR and 0 to use and AND.
|
| Right parenthesis
| Boolean
| Use -1 to specify a right
parenthesis for this condition. This parenthesis is used to
join another condition with Ands and Ors.
|
| Negation[01]
| Boolean
| Use -1 to negate this
condition. |
|
| Layout options
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| VisibleLayout
|
|
| Number
| VisbleLayout
| Specifies the layout
number in which to show the control.
|
| VisibleLayoutOrder
|
|
| Boolean
|
| Specifies whether to show
the chart and grid left or top of each order.
|
| VisibleTitle
|
|
| Boolean
|
| Specifies whether to show
the control title or not. Please use VisibleLayout instead.
|
| VisibleHeading
|
|
| Boolean
|
| Specifies whether to show
the control heading or not. Please use VisibleLayout instead.
|
| VisibleMatrix
|
|
| Boolean
|
| Specifies whether to show
the control data matrix or not. Please use VisibleLayout instead.
|
| VisibleChart
|
|
| Boolean
|
| Specifies whether to show
the control chart or not (if applicable). Please use VisibleLayout instead.
|
| VisiblePopupMenu
|
|
| Boolean
|
| Specifies whether to show
the popup menu or not.
|
| VisibleToolbar
|
|
| Boolean
|
| Specifies whether to show
the toolbar or not.
|
| VisibleButtonOpen
|
|
| Boolean
|
| Specifies whether to show
the open toolbar button or not.
|
| VisibleButtonSave
|
|
| Boolean
|
| Specifies whether to show
the save toolbar button or not.
|
| VisibleButtonCommitCube
|
|
| Boolean
|
| Specifies whether to show
the commit cube toolbar button or not on write enabled cubes.
|
| VisibleButtonRefreshCube
|
|
| Boolean
|
| Specifies whether to show
the refresh cube toolbar button or not.
|
| VisibleButtonRefreshTimer
|
|
| Boolean
|
| Specifies whether to show
the refresh cube timer toolbar button or not.
|
| VisibleButtonPortfolioAdd
|
|
| Boolean
|
| Specifies whether to show
the portfolio add toolbar button or not.
|
| VisibleButtonPortfolioEdit
|
|
| Boolean
|
| Specifies whether to show
the portfolio edit toolbar button or not.
|
| VisibleButtonPortfolioPlay
|
|
| Boolean
|
| Specifies whether to show
the portfolio play toolbar button or not.
|
| VisibleButtonPortfolioSeq
|
|
| Boolean
|
| Specifies whether to show
the portfolio movement toolbar buttons or not.
|
| VisibleButtonPortfolioStop
|
|
| Boolean
|
| Specifies whether to show
the portfolio stop toolbar buttons or not.
|
| VisibleButtonSequence
|
|
| Boolean
|
| Specifies whether to show
the history sequence movement toolbar buttons or not.
|
| VisibleButtonPageSetup
|
|
| Boolean
|
| Specifies whether to show
the page setup toolbar button or not.
|
| VisibleButtonPrintPreview
|
|
| Boolean
|
| Specifies whether to show
the print preview toolbar button or not.
|
| VisibleButtonPrint
|
|
| Boolean
|
| Specifies whether to show
the print toolbar button or not.
|
| VisibleButtonExport
|
|
| Boolean
|
| Specifies whether to the
export toolbar button or not.
|
| VisibleButtonCopy
|
|
| Boolean
|
| Specifies whether to show
the copy toolbar button or not.
|
| VisibleButtonPaste
|
|
| Boolean
|
| Specifies whether to show
the paste and paste toolbar button or not.
|
| VisibleButtonDirectMDX
|
|
| Boolean
|
| Specifies whether to show
the direct MDX toolbar button or not.
|
| VisibleButtonShowElements
|
|
| Boolean
|
| Specifies whether to show
the show elements dialog toolbar button or not.
|
| VisibleButtonTranspose
|
|
| Boolean
|
| Specifies whether to show
the chart transpose toolbar button or not.
|
| VisibleButtonSwapXY
|
|
| Boolean
|
| Specifies whether to show
the swap x y data axis toolbar button or not.
|
| VisibleButtonLayout
|
|
| Boolean
|
| Specifies whether to show
the cube layout dialog toolbar button or not.
|
| VisibleButtonCubeOption
|
|
| Boolean
|
| Specifies whether to show
the cube option dialog toolbar button or not.
|
| VisibleButtonDimOption
|
|
| Boolean
|
| Specifies whether to show
the dimension option dialog toolbar button or not.
|
| VisibleButtonGridOption
|
|
| Boolean
|
| Specifies whether to show
the grid option toolbar button or not.
|
| VisibleButtonPreferences
|
|
| Boolean
|
| Specifies whether to show
the preferences toolbar button or not.
|
| VisibleButtonAbout
|
|
| Boolean
|
| Specifies whether to show
the about box button or not.
|
| Display options.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| Appearance
|
|
| Number
|
| Sets the control general
appearance. Use:
| 0
| Flat style
|
| 1
| 3D style
|
| 2
| 3D Flat style |
|
| Font
|
|
| Character
| 0,0,0,Arial,
8.25,0,0,400
| Specifies the dimension
titles and names font. The font is specified in a character string
separated by commas, where each part represents:
| Bold
| Use -1 for bold font, 0 otherwise.
|
| Charset
| Use the Charset number for the font. The
default is zero.
|
| Italic
| Use -1 for italic font, 0 otherwise.
|
| Name
| Font name, must exists on machine.
|
| Size
| Font size in points.
|
| Strikethrough
| Use -1 for strikethrough font, 0
otherwise. It is always reset to 0.
|
| Underline
| Use -1 for underline font, 0
otherwise. It is always reset to 0.
|
| Weight
| Sets the font weight. Use 400 if you
don't know what to use. |
|
| FontData
|
|
| Character
| See Font above
| Specifies the data values
font.
|
| FontSubtotal
|
|
| Character
| See Font above
| Specifies the dimension
titles and names font when displaying subtotal values.
|
| FontDataSubtotal
|
|
| Character
| See Font above
| Specifies the data values
font when displaying subtotal values.
|
| DataFormat
|
|
| Character
| ($#,##0.00)
| Specifies the data format
that is used to display the grid.
|
| BackColor
|
|
| Color
| &H0ef1a4
| It's the dimension fields
area back color.
The color is represented as
an RGB triplet in hexadecimal format. The example assigns: Red: 15
Green: 241 Blue: 164.
|
| BackColorData
|
|
| Color
|
| It's the data values area
back color. See above BackColor for more information.
|
| BackColorSubtotal
|
|
| Color
|
| It's the dimension
field's area back color
when displaying subtotals. See above BackColor for more information.
|
| BackColorDataSubtotal
|
|
| Color
|
| It's the data values area
back color when displaying subtotals. See above BackColor for more information.
|
| ForeColor
|
|
| Color
|
| It's the dimension
field's area fore
color. See above BackColor for more information.
|
| ForeColorData
|
|
| Color
|
| It's the data values area
fore color. See above BackColor for more information.
|
| ForeColorSubtotal
|
|
| Color
|
| It's the dimension
field's area fore color
when displaying subtotals. See above BackColor for more information.
|
| ForeColorDataSubtotal
|
|
| Color
|
| It's the data values area
fore color when displaying subtotals. See above BackColor for more information.
|
| GridColor
|
|
| Color
|
| It's the dimension
field's area grid
color. See above BackColor for more information.
|
| GridColorData
|
|
| Color
|
| It's the data values area
grid color. See above BackColor for more information.
|
| BorderColor
|
|
| Color
|
| It's the control border
color. See above BackColor for more information.
|
| GridLinesData
|
|
| Number
|
| Sets the lines style used
in the data area grids. You can use one of the following:
| 0
| None
|
| 1
| Flat
|
| 2
| Inset
|
| 3
| Raise
|
| 4
| Flat horizontal
|
| 5
| Inset horizontal
|
| 6
| Raised horizontal
|
| 7
| Skipped horizontal
|
| 8
| Flat vertical
|
| 9
| Inset vertical
|
| 10
| Raised vertical
|
| 11
| Skipped vertical
|
| 12
| Explore
|
| 13
| Excel |
|
| GridLines
|
|
| Number
|
| Sets the lines style used
in the dimension fields area grids. See above GridLinesData for which values to use.
|
| GridLinesWidth
|
|
| Boolean
|
|
|
| FormatSubtotal
|
|
| Boolean
|
| Use -1 to apply a
different formatting for subtotal values, 0 otherwise.
|
| FormatSubtotalLevel
|
|
| Number
|
| Sets the number of
subtotal levels to apply a different formatting. It never applies
subtotal formatting to the last level, regardless of this value.
|
| Conditional
format.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| SemaphoreType
|
|
| Boolean
|
| Sets the semaphore type
when display different cube values with different colors.
This variable is of OlapXSemaphoreTypes type. You can use:
| 0
| No semaphore is applied
|
| 1
| Absolute values semaphore
|
| 2
| Average cube view value.
Use % from this value in SemaphoreMinValue and SemaphoreMaxValue
|
| 3
| Median cube view value.
Use % from this value in SemaphoreMinValue and SemaphoreMaxValue
|
| 4
| Standard deviation cube
view value. Use % from this value in SemaphoreMinValue and SemaphoreMaxValue
|
| 5
| Variation cube view value.
Use % from this value in SemaphoreMinValue and SemaphoreMaxValue |
| 6
| Fields. Use % from the
combintation of theses fields values in SemaphoreMinValue and SemaphoreMaxValue |
|
| SemaphoreMinValue
|
|
| Number
|
| When displaying
semaphores, keeps the lower value. Use absolute values or percentage
values depending on the SemaphoreType variable.
|
| SemaphoreMaxValue
|
|
| Number
|
| When displaying
semaphores, keeps the upper value.
|
| SemaphoreAxis
|
|
| Number
|
| Specifies how to
calculate the semaphore type. Either calculates the formula using the horizontal
values or the vertical values.
Remember that
there is an average to the columns and another average for each row.
You can use
| 1
| Horizontal axis
|
| 2
| Vertical
axis |
|
| SemaphoreRotate
|
|
| Boolean
|
| Specifies whether to
rotate the semaphore formula when the cube axes get swapped or not.
|
| SemaphoreFieldNum
|
|
| Number
|
| Sepecifies the number of
fields that are in the semaphore list field
|
| SemaphoreField
| Field #
|
| Character
| [Class].[Total]
| Keeps the field whose
value will be used to compare against. There has to be at least one
field from an oposiing axis dimension.
|
| SemaphorePlacesNum
|
|
| Number
|
| Specifies the number of
columns or rows where the conditional format will be applied, If
there are no places, this format will be applied in all the cube
|
| SemaphorePlaces
| Place #
|
| Axis,Column|Row
| 1,3
| Consists of two fields.
An axis (column or row) and the column or row number. Use:
| 1
| Horizontal axis
|
| 2
| Vertical
axis | a comma and a column
number for horizontal axis and a row number for the vertical
axis.
|
| ThresholdMinBackColor
|
|
| Color
|
| Specifies the back color to apply if a value
cell is below SemaphoreMinValue. See BackColor for information about colors.
|
| ThresholdMedBackColor
|
|
| Color
|
| Specifies the back color to apply if a value
cell is between SemaphoreMinValue and SemaphoreMaxValue. See BackColor for information about colors.
|
| ThresholdMaxBackColor
|
|
| Color
|
| Specifies the back color to apply if a value
cell is above SemaphoreMaxValue. See BackColor for information about colors.
|
| ThresholdMinForeColor
|
|
| Color
|
| Specifies the fore color to apply if a value
cell is below SemaphoreMinValue. See BackColor for information about colors.
|
| ThresholdMedForeColor
|
|
| Color
|
| Specifies the fore color to apply if a value
cell is between SemaphoreMinValue and SemaphoreMaxValue. See BackColor for information about colors.
|
| ThresholdMaxForeColor
|
|
| Color
|
| Specifies the fore color to apply if a value
cell is above SemaphoreMaxValue. See BackColor for information about colors.
|
| ActThresholdMinBackColor
|
|
| Boolean
|
| Use -1 to apply the color
this variable indicates and 0 otherwise.
|
| ActThresholdMedBackColor
|
|
| Boolean
|
| Use -1 to apply the color
this variable indicates and 0 otherwise.
|
| ActThresholdMaxBackColor
|
|
| Boolean
|
| Use -1 to apply the color
this variable indicates and 0 otherwise.
|
| ActThresholdMinForeColor
|
|
| Boolean
|
| Use -1 to apply the color
this variable indicates and 0 otherwise.
|
| ActThresholdMedForeColor
|
|
| Boolean
|
| Use -1 to apply the color
this variable indicates and 0 otherwise.
|
| ActThresholdMaxForeColor
|
|
| Boolean
|
| Use -1 to apply the color
this variable indicates and 0 otherwise.
|
| Row, column and
cell format.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| GridFormatNum
|
|
| Number
|
| Specifies the number of
cell formatting that have been applied.
|
| GridFormat
|
|
| Character
| 0,1,1,&H0ef1a4,
&Hffffff,0,0,0,Arial,
8.25,0,0,400,#{}###
| It's an element for the
cell format list. It is composed of the following fields:
| Type
| Specifies where this cell
format applies to:
|
|
| 0
| Applies to a single cell
|
| 1
| Applies to row grid
|
| 2
| Applies to column
grid |
| Row
| Row where the format is
applied
|
| Column
| Row where the format is
applied
|
| Backcolor
| Back color of the format
|
| Forecolor
| Fore color of the format
|
| Font
| All the fields that
specify the font. See Font above.
|
| Dataformat
| All the fields that
specify the font. See Dataformat above.
| |
|
| RotateGridFormat
|
|
| Boolean
|
| Set to True (-1) if you
want your cell format to rotate with cube rotations.
|
| Pop menu options.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| AutoHierarchy
|
|
| Number
| ShowHierarchy
| Specifies the pop menu
option of the hierarchy submenu.
|
| AutoPareto
|
|
| Number
| ShowPareto
| Specifies the pop menu
option of the pareto submenu.
|
| AutoCubeView
|
|
| Number
| ShowCubeView
| Specifies the pop menu
option of the cube view submenu.
|
| SortFlag
|
|
| Number
| Sort
| Specified whether a sort
action is ascending or descending. This field is of type OlapXSortFlag. Use:
| 0
| None
|
| 1
| Ascending
|
| 2
| Descending |
|
| HiddenElementsNum
|
|
| Number
|
| Specifies the number of
elements in the hidden elements list.
|
| HiddenElement
|
|
| Character
|
| Add an element to the
hidden elements list. Something like [Customers].[Americas].
|
| Page setup.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| Comment1
|
|
| Character
|
| Sets the Comments 1 of
the page setup dialog.
|
| Comment2
|
|
| Character
|
| Sets the Comments 2 of
the page setup dialog.
|
| ChartInNewPage
|
|
| Boolean
|
| If there is not enough
space to print the chart in the same page as the data, it prints the
chart in a new page.
|
| BW
|
|
| Boolean
|
| Uses black and white only
when printing data grids, forgoing any color format.
|
| Template |
|
|
Character |
|
Sets the printing
template to use. Use the page setup dialog to manage templates.
|
| TemplateP |
|
|
Character |
|
Sets the printing
template when printing portfolios. |
| TemplatePS |
|
|
Character |
|
Sets the printing
template for each portfolio slide when exporting portfolios to one
file. |
| TemplatePP |
|
|
Character |
|
Sets the printing
template when exporting portfolios slides to one file each
slide. |
| TemplatePI
|
|
| Character
|
| Sets the printing
template to use for an index file when exporting portfolios, each
slide to one file.
|
| BackImage |
|
|
Character |
|
Image file name to use as
page background. Doesn't apply to export fo html. Use |
| Logo
|
|
| Character
|
| Your logo file name to
use when printing.
|
| Orientation
|
|
| Character
|
| Use an H for horizontal
or landscape printing, otherwise vertical or portrait printing is
used. |
| HTMLTemplate |
|
|
Character |
|
A custom HTML template
that you would like to use. See user's guide form information on
HTML templates. |
| HTMLPortfolioTemplate |
|
|
Character |
|
A custom HTML template
that you would like to use for the portfolio. |
| HTMLSlideTemplate |
|
|
Character |
|
A custom HTML template
that you would like to use to for each portdolio page.
(Printing all pages in one file) |
| HTMLPageTemplate |
|
|
Character |
|
A custom HTML template
that you would like to use to for each portdolio page.
(Printing each page in one file) |
| HTMLIndexTemplate
|
|
| Character
|
| A custom HTML template
that you would like to use to the portfolio index page. |
| Enable and disable
actions.
|
| Variable
| Index1
| Index2
| Value
| Example
|
|
| EnableAction
|
|
| Character
| DisableAction
| Enables action
"action". It can be
called from doAction.
|
| DisableAction
|
|
| Character
| DisableAction
| Disables action "action". doAction doesn't execute it until
it is enabled again.
|
|