|
Public Member Functions |
| HRESULT | AddAssociatedRWNodeInfo ([in] EnumDSSRWTreeType TreeType,[in] BSTR Key,[in] BSTR AssociatedNodeKey,[in] Int32 lManipCat) |
| | Add associated RWNode info for a given node (currently should be a template node).
|
| HRESULT | AddMetricEX ([in] EnumDSSRWTreeType TreeType,[in] BSTR Key,[in] IDSSObjectInfo *pObject,[in] IDSSObjectInfo *pDataSet,[in] Int32 Position,[in, optional] BSTR DisplayName) |
| HRESULT | AddUnitEX ([in] EnumDSSRWTreeType TreeType,[in] BSTR Key,[in] IDSSObjectInfo *pObject,[in] IDSSObjectInfo *pDataset,[in] Int32 AxisIndex,[in] Int32 UnitIndex,[in, optional] BSTR DisplayName) |
| HRESULT | ApplyReconciliation ([in] IDSSReconciliation *ipReconciliation) |
| HRESULT | ClearAssociatedRWNodeInfo ([in] EnumDSSRWTreeType TreeType,[in] BSTR Key,[in] BSTR AssociatedNodeKey,[in] Int32 lManipCat) |
| | Clear associated RWNode info for a given node (currently should be a template node).
|
| HRESULT | ClearSorts2 ([in] EnumDSSRWTreeType TreeType,[in] BSTR Key,[in] VARIANT *pIndex,[in, optional] EnumDSSAxisName Axis) |
| | If the node points to a groupby section, it clears the sorts of the group by units If the node points to a template, it clears all sorts on the given axis If the node points to a field group, it clear all sorts on the field group.
|
| HRESULT | SetAttributeFormDisplayOption ([in] EnumDSSRWTreeType iTreeType,[in] BSTR iNodeKey,[in] VARIANT *ipIndex,[in] EnumDSSAttributeFormDisplayOption iAttributeFormDisplayOption) |
| | Set attribute form display option for a control/groupby unit.
|
| HRESULT | SetAttributeForms ([in] EnumDSSRWTreeType iTreeType,[in] BSTR iNodeKey,[in] VARIANT *ipIndex,[in] SAFEARRAY(BSTR)*ipFormIds) |
| | Set attribute forms for a control/groupby unit.
|
| HRESULT | SetDelimiter ([in] EnumDSSRWTreeType iTreeType,[in] BSTR iNodeKey,[in] VARIANT *ipIndex,[in] BSTR iDelimiter) |
| | Set delimiter for a control/groupby unit.
|
| HRESULT | SetSelectionFromOriginalDocument ([in] IDSSDocumentDefinition *pOriginalDocDefn,[in, optional] Int32 iFlag) |
| HRESULT | Sort2 ([in] EnumDSSRWTreeType TreeType,[in] BSTR Key,[in] VARIANT *pIndex,[in] EnumDSSSortType SortType,[in] VARIANT_BOOL Ascending,[in] EnumDSSSubtotalsPosition SubtotalsPosition,[in] IDSSObjectInfo *pSortingObject,[in] EnumDSSAxisName Axis,[in] VARIANT *pAdditionalInfo,[in] SAFEARRAY(BSTR)*pElementsArray) |
| | If the node points to a groupby section, it adds a single key sort to the group by units, before any other existing sorts.
|
| HRESULT | UnSelectAllDerivedElementReference ([in]EnumDSSRWTreeType TreeType,[in]BSTR Key,[in]IDSSAttribute *ipAttribute,[in, defaultvalue(0)]Int32 iFlag) |
|
|
If the node points to a groupby section, it adds a single key sort to the group by units, before any other existing sorts.
If the node points to a template, it adds a single key sort to a given axis of the template, before any other existing sorts on the axis. If the node points to a field group, it adds a single key sort to the field group. If the node points to a control, it adds a single key sort to the control. - Parameters:
-
| TreeType | Type of tree, namely content, page header or page footer |
| Key | Key of the node to be edited. |
| pIndex | the index of the control in the specified node. |
| SortType | The type of sort to be added. |
| Ascending | The direction of the sort. |
| SubtotalsPosition | Specifies a change, from this sort on, in how the subtotals are positioned. |
| pSortingObject | The sorting object. |
| Axis | The axis whose rows should be ordered by this sort. |
| pAdditionalInfo | Parameter whose meaning depends on the type of sort:
- For an attribute sort, the attribute form to sort on (IDSSAttributeForm)
- For a hierarchical sort (only applied to template or field group), the subtotal definition, as one of the following:? An EnumDSSMetricType value specifying a subtotal (from DssMetricSubtotalSum to DssMetricSubtotalGeometricMean)? A reference (IDSSMetric) to a subtotal definition? The DSSID (BSTR) of a subtotal definition (metric)
- For a custom group sort, an array of 2 values. The first one (index 1) is a value from the EnumDSSOrderParentFirst enumeration. See below for detailed description. The second one (index 2) is a value from the EnumDSSCustomGroupSortType enumeration, specifying the type of the sort. For backward compatibility, we also support the method described below, which only passes in the EnumDSSOrderParentFirst.
- For a custom group sort, a value from the EnumDSSOrderParentFirst enumeration specifying the position of parent elements relative to child elements. The options are: parent first, children first and default (in which case the decision on the parent-children order will be made based on the setting of the IsParentFirst property of the related custom group object).
|
| pElementsArray | For a metric sort(only applied to grid), the collection of elements determining the exact vector (on the grid) that will drive the sort. |
|