Microsoft Excel reporting and 
 data analyzing with practically no coding. 
 .Net, ActiveX, and VCL versions. 
 www.AfalinaSoft.com  

Home    Products    Downloads    Registered users    Support    Prices    Order    Primary Subscription

 

MS Office COM Add-ins. Microsoft Excel reporting 
 and data analyzing


Appendix C: Option map - AfalinaSoft Active XL Report Developer's Guide

<< Previous

Table of contents

Next >>


Appendix C: Option map


Standard options

Option

Parameters

Applicable to

RangeType

OnlyValues

 

Workbook, Worksheet, Range, Column

ListRange, RootRange

Replaces formulas with their values.

AutoSafe

 

Workbook, Worksheet

 

If used in a workbook, protects the workbook and all of its worksheets. If used in a worksheet, protects the worksheet. Anologous to "Tools|Protection|Protect Sheet..." and "Tools|Protection|Protect Workbook..."

RowsFit

 

Workbook, Worksheet, Range

ListRange, RootRange

Makes the row height fit the cell's contents.

ColsFit

 

Workbook, Worksheet, Range

ListRange, RootRange

Makes the column width fit the cell's contents.

SheetHide, Hide

 

Worksheet

 

Hides the worksheet. If Debug is on, provides "soft" hiding that allows unhiding the worksheet through "Format|Sheet|Unhide...".

AutoScale

 

Workbook, Worksheet

 

If used in a workbook, protects the workbook and all of its worksheets. If used in a worksheet, protects the worksheet. Analogous to "Tools|Protection|Protect Sheet..." and "Tools|Protection|Protect Workbook..."

AutoFilter

 

Range

ListRange

Turn on the Autofilter in the range.

Sort

[/Desc]
[/Asc]

Column

ListRange, DetailRange

Provides sorting for the column. The sort order is either Asc (default) or Desc. Up to three columns can be sorted at once. Columns for sorting are taken in right-to-left order.

Desc

 

Column

ListRange, DetailRange

The same as Sort/Desc

Asc

 

Column

ListRange, DetailRange

The same as Sort/Asc

Sum
Avg or Average
Count
CountNums
Min
Max
Product
StDev
StDevP
Var
VarP

 

Column

ListRange, RootRange, MasterRange, DetailRange

Summary options are used in totals and subtotals, and pivot tables. You can get only one total for a column. If you indicate more than one summary option only the last one is used. Totals are inserted into the option row

Group

[/Asc]
[/Desc]
[/Collapse]

Column

ListRange

Groups the data in the column where it is used, produces subtotals for columns with any of summary options used, and outlines the range. The range is sorted previously by the columns containing any of the following options: Group, Sort, Desc, and Asc (See also: GroupNoSort and summary options). The sort order is determined by specifying the Desc or Asc parameter (default - Asc).
If several Group options are used in a range, then the data are grouped in right-to-left order creating several levels in an outline. The Collapse parameter hides the detail data in the outline up to the level containing the Group option with this parameter.
Subtotal rows are formatted according to the option row formatting.

GroupNoSort

 

Range

ListRange

Prevents the range to be sorted. Can be used in case of previously sorted data. Speeds up the report creation.

Pivot

[/Name=name1]
[/Dst=dst1]
[/DataToRows]
[/RowGrand]
[/ColumnGrand]
[/MergeLabels]
[/NoPreserveFormatting]
[/Refresh=PivotTableList]

Range

ListRange

Produces a pivot table basing on the range. In order to describe the structure of the pivot table the pivot description options are used: Page, Row, Column, and Data. These options allow specifying destinations (the pivot table areas) for your data. The fields that are not designated to any of the pivot table's areas are included into the pivot table as hidden ones. The end user is allowed to change the pivot table structure.The Name parameter is required. The name must be allowable in Excel.The Dst parameter allows specifying the placement of the pivot table. You can specify both the worksheet name for the pivot table to be placed on and the top left corner of the pivot table (page fields included). If the worksheet name is omitted, a new worksheet named after the pivot table is inserted. The placement of the pivot table's top left corner can be given in either A1 or R1C1 style. Examples: Dst=Sheet1!D8; Dst=D8.In case of several data fields, the DataToRows parameter places data field labels in rows (they are placed in columns by default).The RowGrand and ColumnGrand parameters show grand totals for rows and columns respectively.
The MergeLabels parameter allows using merged cells in outer-row item, column item, subtotal, and grand total labels.The NoPreserveFormatting parameter prevents the source range formats to be applied to the pivot table. Use it in order to speed up the report.
The Refresh parameter allows specifying the list of static pivot tables connected with the range.
The pivot table names must be preceded with the name of the worksheet containing the pivot table (WorksheetName!PivotTanleName) and separated with semicolon. If either the worksheet name or pivot table name contain spaces, it shouldn't be enclosed in single quotation marks.The pivot table technical parameters and limitations can be found in MSDN.

Page

 

Column

ListRange

Produces a pivot table field basing on the column and places it into the Page Area of the pivot table. The name of the field is the label of the column.

Row

 

Column

ListRange

Produces a pivot table field basing on the column and places it into the Row Area of the pivot table. The name of the field is the label of the column.
Excel provides grouping of inner-row items for every outer-row item and inserts subtotals if necessary. The type of subtotals is determined by specifying an additional summary option(s) along with the Row option of the source column. For example, Row;Sum;Count options given in a column produce sum and count subtotals for the corresponding pivot table field.

Column

 

Column

ListRange

Produces a pivot table field basing on the column and places it into the Column Area of the pivot table. The name of the field is the label of the column.
You can insert one or more subtotals for a pivot table field. The type of subtotals is determined by specifying an additional summary option(s) along with the Column option of the source column. For example, Column;Sum;Count options given in a column produce sum and count subtotals for the corresponding pivot table field.

Data

 

Column

ListRange

Produces a pivot table field basing on the column and places it into the Data Area of the pivot table. The name of the field is the label of the column. The field label are placed in columns (see also the DataToRows parameter of the Pivot option).
Data fields are summed by default. In order to apply any different summary function, add an appropriate summary option to the Data option.



Pro options

Option

Parameters

Applicable to

RangeType

Sum
Avg or Average
Count
CountNums
Min
Max
Product
StDev
StDevP
Var
VarP

TotalOfRow=row

Column

ListRange, RootRange, MasterRange, DetailRange

Extended summary options.
Extends standard option functionality allowing totaling in arbitrary ranges. This feature is accessed through the use of the TotalOfRow parameter that accepts the row for which you want to get a summary.

Chart

Name=n

Range

ListRange

Obligatory. Refreshes the chart specified in n with data from the range. N must contain the full name of a chart, including the sheet name.

DeleteColumn

 

Column

ListRange, RootRange

Deletes the column where the option is used.

Group

Collapse
Desc
Asc
MergeLabels
MergeLabels2
PlaceToColumn=n
WithHeader
Disablesubtotals
DisableOutline
PageBreaks

Column

ListRange, DetailRange

Extends the functionality of the standard Group option. The range where the option is used must be a list (see Appendix A).
Allows creating subtotals in the ranges of the lowest level of nesting in master-detail reports. Can be used in absence of the summary options. In such a case, data are grouped without subtotals. The option row formatting is used for formatting subtotals and group headers.
In the presence of the SummaryAbove option (see below), subtotals are placed above grouped values.
The Collapse, Asc, and Desc parameters are the same as in the standard option pack.
MergeLabels and MergeLabels2 cause merging of cells in the grouped column.
PlaceToColumn allows placing the group header to a specified column.
DisableSubtotals turns off subtotals for the grouped column. Useful in report debugging. Sorts data within the group.
DisableOutline turns off an outline for the grouped column.
PageBreaks inserts page breaks between groups.
WithHeader creates a header in case of subtotals.

GroupNoSort

 

Range

ListRange, DetailRange

The same as the standard option but can be used with extended Group option. The range where the option is used must be a list (see Appendix A).

DisableGrandTotals

 

Range

ListRange

Suppresses grand totals in the case of grouping with subtotals.

SummaryAbove
SummaryBelow

 

Range

ListRange, DetailRange

Additional options to be used together with the Group option. SummaryAbove allows placing summary above grouped values. SummaryBelow (default) places summary below data.
The range where the option is used must be a list (see Appendix A).

GroupWithHeader

 

Range

ListRange

Creates a group header for a subtotaled range. Works with range of a special format only.

Outline

CollapseLevel=level

Range

RootRange

Allows creating the Outline view corresponding to the structure of nested ranges. Is used at the topmost level of nesting. Can be used together with the SummaryAbove and SummaryBelow options. Outline doesn't cover subtotals. Clears the outline created by the Group option.
Use the CollapseLevel parameter in order to show only a specific level in an outline.


<< Previous

Table of contents

Next >>



Components

axlr axlr.ocx

Data Access methods

  • ADO
  • DAO
  • RDO
  • custom data

Excel version supported

MS Excel 97 (SR2)
MS Excel 2000
MS Excel 2002 (XP)
MS Excel 2003



[ Download it ]
[ Order now ]

Copyright © 1999-2006
All right reserved.
Privacy Policy

Write to WebMaster

Page Top
Add-in Express - COM Add-ins, Smart Tags and RTDS in C#, VB, C++, J#, and Delphi