IDSSReportManipulation8 Interface Reference

Inherits IDSSReportManipulation7.

Inherited by IDSSReportManipulation9.

List of all members.

Public Member Functions
HRESULT	AddDerivedElement ([in] IDSSAttribute *ipAttribute,[in] IDSSConsolidationElement *ipDerivedElement,[in, defaultvalue(0)] Int32 iPosition,[out, retval] IDSSConsolidationElement oppNewDerivedElement)
	AddDerivedElement is used to create a local embedded derived element and insert it under the special hidden derived element that is referred by the template attribute unit limit.
HRESULT	AddDerivedElementReference ([in] IDSSAttribute *ipAttribute,[in] VARIANT *ipDerivedElement)
	AddDerivedElementReference is used to refer a derived element as the root node of the unit limit of a template attribute unit.
HRESULT	ApplyDeliveryThresholds ()
	Applies the delivery thresholds to the report.
HRESULT	ClearDerivedElementReference ([in] IDSSAttribute *ipAttribute,[in, defaultvalue(0)] Int32 iFlag)
	ClearDerivedElementReference is used to clear the unit limit expression.
HRESULT	CreateThreshold ([in] IDSSObjectInfo *ipMetricInfo,[in] Int32 iIndex,[in] VARIANT_BOOL iIsEnabled,[in] IDSSObjectInfo *ipFormatInfo,[in] VARIANT *ipCondition,[in] BSTR iName,[in] BSTR iReplaceText,[in] BSTR iPrefix,[in] BSTR iSuffix,[in] EnumDSSBaseFormType iSemantics,[in] EnumDSSThresholdScope iScope)
	Create a threshold in the specified template metric.
HRESULT	FormatDerivedElement ([in] IDSSAttribute *ipAttribute,[in] VARIANT *ipDerivedElement,[in] EnumDSSFormat iFormat,[in] IDispatch *pFormatXML)
	FormatDerivedElement is used to set the format on a derived element locally defined on a view report.
HRESULT	RemoveDerivedElement ([in] IDSSAttribute *ipAttribute,[in] VARIANT *ipDerivedElement,[in, defaultvalue(0)] Int32 iFlag)
	RemoveDerivedElement is used to remove a derived element from the derived element collection of the view report.
HRESULT	RemoveThreshold ([in] IDSSObjectInfo *ipMetricInfo,[in] Int32 iIndex)
	Remove a threshold in the specified template metric.
HRESULT	RemoveWidgetString ([in] BSTR iStringKey)
	Remove the widget string for the given string key from the report definition.
HRESULT	SelectDerivedElementReference ([in] IDSSAttribute *ipAttribute,[in] VARIANT *ipDerivedElements,[in, defaultvalue(NULL)] VARIANT *ipParentDerivedElement,[in, defaultvalue(0)] Int32 iPosition)
	SelectDerivedElementReference is used to add reference of one or more derived elements under the reference node of derived element of the unit limit of a template attribute unit.
HRESULT	SetCubeReport ([in] IDSSReportDefinition *ipBaseReport,[in, defaultvalue(0)] Int32 iFlag)
	SetCubeReport is used to set the base report for a subset report.
HRESULT	SetDerivedElementHierarchyOption ([in] IDSSAttribute *ipAttribute,[in] VARIANT *ipDerivedElement,[in, defaultvalue(TRUE)] VARIANT_BOOL iIsSpliced,[in, defaultvalue(TRUE)] VARIANT_BOOL iCanExpand)
	SetDerivedElementHierarchyOption is used to set the hierarchy option (i.e., CanExpand and IsSpliced) on a derived element.
HRESULT	SetDerivedElementProperties ([in] IDSSAttribute *ipAttribute,[in] VARIANT *ipDerivedElement,[in, defaultvalue(1)] Int32 iIsSmart,[in, defaultvalue(DssDEAggregationSelf)] EnumDSSDEAggregation iDEAggregation,[in, defaultvalue(1)] Int32 iApplyToAllOther)
	SetDerivedElementProperties is used to set the IsSmart, DEAggregationi, and ApplyToAllOther properties on a derived element.
HRESULT	SetEvaluationOrder ([in] IDSSObjectInfo *ipObject,[in] Int32 iEvalOrder,[in] VARIANT_BOOL iUseViewTemplate,[in, defaultvalue(FALSE)] VARIANT_BOOL iIsTemplateSubtotal,[in, defaultvalue(NULL)] DSS_ID *ipSubtotalID,[in, defaultvalue(-1)] Int32 iSubtotalIndex)
HRESULT	SetUnitHyperlinksXML ([in] IDSSObjectInfo *ipObject,[in] IDispatch *ipHyperlinksXML)
	Set hyperlinks on a template unit through XML.
HRESULT	SetWidgetString ([in] BSTR iStringKey,[in] BSTR iString)
	Set the widget string for the given string key on the report definition.
HRESULT	UnSelectDerivedElementReference ([in] IDSSAttribute *ipAttribute,[in] VARIANT *ipDerivedElement,[in, defaultvalue(NULL)] VARIANT *ipParentDerivedElement)
	UnSelectDerivedElementReference is used to remove reference of one or more derived elements under the reference node of derived element of the unit limit of a template attribute unit.
HRESULT	UpdateDerivedElement ([in] IDSSAttribute *ipAttribute,[in] VARIANT *ipDerivedElement,[in] IDSSConsolidationElement *ipNewDerivedElement,[in, optional] BSTR iNewName,[in, defaultvalue(0)] Int32 iNewPosition)
	UpdateDerivedElement is used to update the definition of a derived element locally defined on a view report.

---

Member Function Documentation

HRESULT IDSSReportManipulation8::AddDerivedElement (  [in] IDSSAttribute *  ipAttribute, [in] IDSSConsolidationElement *  ipDerivedElement, [in, defaultvalue(0)] Int32  iPosition, [out, retval] IDSSConsolidationElement   oppNewDerivedElement )

AddDerivedElement is used to create a local embedded derived element and insert it under the special hidden derived element that is referred by the template attribute unit limit. Parameters: ipAttribute  The attribute unit that the derived element will be added on. It should not be NULL. ipDerivedElement  The derived element. It should not be NULL. iPosition  The Optional index that the derived element should be added. Default to the end. oppNewDerivedElement  The new derived element that is added. Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute RPTSVC_E_NOT_DERIVED_ELEMENT The de0 is not a derived element RPTSVC_E_DE0_NOT_MANAGED The de0 is not a managed derived element (embedded object)

HRESULT IDSSReportManipulation8::AddDerivedElementReference (  [in] IDSSAttribute *  ipAttribute, [in] VARIANT *  ipDerivedElement )

AddDerivedElementReference is used to refer a derived element as the root node of the unit limit of a template attribute unit. Parameters: ipAttribute  The attribute unit that refers the derived element. It should not be NULL. ipDerivedElement  The derived element to be referred by the template attribute unit. It must be a stand alone derived element. BSTR String: ID of an existing derived element Pointer: reference to an existing derived element Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute RPTSVC_E_DERIVED_ELEMENT_MANAGED The input de is a managed one (it should be a stand alone)

HRESULT IDSSReportManipulation8::ApplyDeliveryThresholds (   )

Applies the delivery thresholds to the report. This means that the condition for all the delivery thresholds in the template are moved to the template's metric limits. This should produce a report that when run, only returns data that satisfies the delivery threshold conditions

HRESULT IDSSReportManipulation8::ClearDerivedElementReference (  [in] IDSSAttribute *  ipAttribute, [in, defaultvalue(0)] Int32  iFlag )

ClearDerivedElementReference is used to clear the unit limit expression. Parameters: ipAttribute  The attribute to identify a template attribute unit. It should not be NULL iFlag  The Optional flags that specifies the behavior of the manipulation Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute

HRESULT IDSSReportManipulation8::CreateThreshold (  [in] IDSSObjectInfo *  ipMetricInfo, [in] Int32  iIndex, [in] VARIANT_BOOL  iIsEnabled, [in] IDSSObjectInfo *  ipFormatInfo, [in] VARIANT *  ipCondition, [in] BSTR  iName, [in] BSTR  iReplaceText, [in] BSTR  iPrefix, [in] BSTR  iSuffix, [in] EnumDSSBaseFormType  iSemantics, [in] EnumDSSThresholdScope  iScope )

Create a threshold in the specified template metric. Parameters: ipMetricInfo  The metric in the report to add new threshold iIndex  Index of the new created threshold in thresholds iIsEnabled  IsEnabled property of the new threshold ipFormatInfo  The format property of the new threshold ipCondition  The condition of the new threshold iName  The name property of the new threshold iReplaceText  The replace text of the threshold iPrefix  The prefix property of the new threshold iSuffix  The suffix property of the new threshold iSemantics  The semantics property of the new threshold iScope  The scope property of the new threshold

HRESULT IDSSReportManipulation8::FormatDerivedElement (  [in] IDSSAttribute *  ipAttribute, [in] VARIANT *  ipDerivedElement, [in] EnumDSSFormat  iFormat, [in] IDispatch *  pFormatXML )

FormatDerivedElement is used to set the format on a derived element locally defined on a view report. Parameters: ipAttribute  The attribute. If set, remove those derived elements whose extended type ipDerivedElement  The derived element. BSTR String: ID of an exsiting derived element Pointer: reference to an exsiting derived element iFormat  The Format to be modified. DssFormatHeader: The header format for the derived element itself DssFormatGrid: The grid format for the derived element data DssFormatChildHeader: The header format for the children of the derived element DssFormatChildGrid: The grid format for the data of the children of the derived element pFormatXML  XML that contains properties that need to be set or unset on the format. Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute RPTSVC_E_NOT_DERIVED_ELEMENT The de0 is not a derived element RPTSVC_E_DE0_NOT_MANAGED The de0 is not a managed derived element (embedded object) RPTSVC_E_DERIVED_ELEMENT_NOT_FOUND The de user wants to format can not be found

HRESULT IDSSReportManipulation8::RemoveDerivedElement (  [in] IDSSAttribute *  ipAttribute, [in] VARIANT *  ipDerivedElement, [in, defaultvalue(0)] Int32  iFlag )

RemoveDerivedElement is used to remove a derived element from the derived element collection of the view report. Parameters: ipAttribute  The attribute unit that refers the derived element. It should not be NULL. ipDerivedElement  The derived element. BSTR String: ID of an exsiting derived element Pointer: reference to an exsiting derived element iFlag  The Optional flags that specifies the behavior of the manipulation. Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute RPTSVC_E_NOT_DERIVED_ELEMENT The de0 is not a derived element RPTSVC_E_DE0_NOT_MANAGED The de0 is not a managed derived element (embedded object) RPTSVC_E_DERIVED_ELEMENT_NOT_FOUND The de user wants to format can not be found

HRESULT IDSSReportManipulation8::RemoveThreshold (  [in] IDSSObjectInfo *  ipMetricInfo, [in] Int32  iIndex )

Remove a threshold in the specified template metric. Parameters: ipMetricInfo  The metric in the report to remove threshold iIndex  Index of the new created threshold in thresholds

HRESULT IDSSReportManipulation8::RemoveWidgetString (  [in] BSTR  iStringKey  )

Remove the widget string for the given string key from the report definition. Parameters: iStringKey  Key for the widget string.

HRESULT IDSSReportManipulation8::SelectDerivedElementReference (  [in] IDSSAttribute *  ipAttribute, [in] VARIANT *  ipDerivedElements, [in, defaultvalue(NULL)] VARIANT *  ipParentDerivedElement, [in, defaultvalue(0)] Int32  iPosition )

SelectDerivedElementReference is used to add reference of one or more derived elements under the reference node of derived element of the unit limit of a template attribute unit. Parameters: ipAttribute  The attribute unit that refers the derived element. It should not be NULL. ipDerivedElements  The derived elements to be referred by the template attribute unit. It could be a local embedded derived element or a stand alone derived element, or a collection of derived elements. BSTR String: ID of an existing derived element Pointer: reference to an existing derived element SafeArray of BSTR: an array of derived element ID SafeArray of Pointer: an array of derived element pointers ipParentDerivedElement  The derived element that identifis the reference node that the reference to the specified derived element will be added to. If NULL, add to root BSTR String: ID of an existing derived element, GUID_NULL means add to root Pointer: reference to an existing derived element, NULL means add to root iPosition  The position under the parent reference node, default to the end. No effect if the parent is the root node. Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute RPTSVC_E_NOT_DERIVED_ELEMENT The de0 is not a derived element RPTSVC_E_INVALID_DE_TO_SELECT The input de to select is not in the embedded folder of de0, that means it's invalid

HRESULT IDSSReportManipulation8::SetCubeReport (  [in] IDSSReportDefinition *  ipBaseReport, [in, defaultvalue(0)] Int32  iFlag )

SetCubeReport is used to set the base report for a subset report. Parameters: ipBaseReport  The base report definition. It should not be NULL. iFlag  The Optional flags that specifies the behavior of the manipulation.

HRESULT IDSSReportManipulation8::SetDerivedElementHierarchyOption (  [in] IDSSAttribute *  ipAttribute, [in] VARIANT *  ipDerivedElement, [in, defaultvalue(TRUE)] VARIANT_BOOL  iIsSpliced, [in, defaultvalue(TRUE)] VARIANT_BOOL  iCanExpand )

SetDerivedElementHierarchyOption is used to set the hierarchy option (i.e., CanExpand and IsSpliced) on a derived element. Parameters: ipAttribute  The attribute. If set, remove those derived elements whose extended type ipDerivedElement  The derived element. BSTR String: ID of an exsiting derived element Pointer: reference to an exsiting derived element iIsSpliced  The boolean value indicates whether to include the derived element itself. iCanExpand  The boolean value indicates whether to expand the children of the derived element. Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute RPTSVC_E_NOT_DERIVED_ELEMENT The de0 is not a derived element RPTSVC_E_DE0_NOT_MANAGED The de0 is not a managed derived element (embedded object) RPTSVC_E_DERIVED_ELEMENT_NOT_FOUND The de user wants to format can not be found

HRESULT IDSSReportManipulation8::SetDerivedElementProperties (  [in] IDSSAttribute *  ipAttribute, [in] VARIANT *  ipDerivedElement, [in, defaultvalue(1)] Int32  iIsSmart, [in, defaultvalue(DssDEAggregationSelf)] EnumDSSDEAggregation  iDEAggregation, [in, defaultvalue(1)] Int32  iApplyToAllOther )

SetDerivedElementProperties is used to set the IsSmart, DEAggregationi, and ApplyToAllOther properties on a derived element. Parameters: ipAttribute  The attribute. If set, remove those derived elements whose extended type ipDerivedElement  The derived element. BSTR String: ID of an exsiting derived element Pointer: reference to an exsiting derived element iIsSmart  -2: do not update it; 1: set it to true; 0: set it to false iDEAggregation  The DEAggregation property. iApplyToAllOther  -2: do not update it; 1: set it to true; 0: set it to false Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute RPTSVC_E_NOT_DERIVED_ELEMENT The de0 is not a derived element RPTSVC_E_DE0_NOT_MANAGED The de0 is not a managed derived element (embedded object) RPTSVC_E_DERIVED_ELEMENT_NOT_FOUND The de user wants to format can not be found

HRESULT IDSSReportManipulation8::SetEvaluationOrder (  [in] IDSSObjectInfo *  ipObject, [in] Int32  iEvalOrder, [in] VARIANT_BOOL  iUseViewTemplate, [in, defaultvalue(FALSE)] VARIANT_BOOL  iIsTemplateSubtotal, [in, defaultvalue(NULL)] DSS_ID *  ipSubtotalID, [in, defaultvalue(-1)] Int32  iSubtotalIndex )

HRESULT IDSSReportManipulation8::SetUnitHyperlinksXML (  [in] IDSSObjectInfo *  ipObject, [in] IDispatch *  ipHyperlinksXML )

Set hyperlinks on a template unit through XML. Parameters: ipObject  Object -> corresponds to a template unit or template metric. NULL -> indicates that the Metrics unit should be modified ipHyperlinksXML  Parent node for hyperlinks XML.

HRESULT IDSSReportManipulation8::SetWidgetString (  [in] BSTR  iStringKey, [in] BSTR  iString )

Set the widget string for the given string key on the report definition. Parameters: iStringKey  Key for the widget string. iString  Widget string.

HRESULT IDSSReportManipulation8::UnSelectDerivedElementReference (  [in] IDSSAttribute *  ipAttribute, [in] VARIANT *  ipDerivedElement, [in, defaultvalue(NULL)] VARIANT *  ipParentDerivedElement )

UnSelectDerivedElementReference is used to remove reference of one or more derived elements under the reference node of derived element of the unit limit of a template attribute unit. Parameters: ipAttribute  The attribute unit that refers the derived element. It should not be NULL. ipDerivedElement  The derived elements to be removed by the template attribute unit. It could be a local embedded derived element or a stand alone derived element, or a collection of derived elements. BSTR String: ID of an existing derived element Pointer: reference to an existing derived element SafeArray of BSTR: an array of derived element ID SafeArray of Pointer: an array of derived element pointers ipParentDerivedElement  The derived element that identifis the reference node that the reference to the specified derived element will be added to. If NULL, add to root BSTR String: ID of an existing derived element, GUID_NULL means add to root Pointer: reference to an existing derived element, NULL means add to root Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute

HRESULT IDSSReportManipulation8::UpdateDerivedElement (  [in] IDSSAttribute *  ipAttribute, [in] VARIANT *  ipDerivedElement, [in] IDSSConsolidationElement *  ipNewDerivedElement, [in, optional] BSTR  iNewName, [in, defaultvalue(0)] Int32  iNewPosition )

UpdateDerivedElement is used to update the definition of a derived element locally defined on a view report. Parameters: ipAttribute  The attribute unit that refers the derived element. It should not be NULL. ipDerivedElement  The derived element. BSTR String: ID of an exsiting derived element Pointer: reference to an exsiting derived element ipNewDerivedElement  The new derived element. It could be NULL if don't want to change the definition iNewName  The name of the derived element. It could be NULL if don't want to change it. iNewPosition  The new index that the derived element should be referred. It could be 0 if don't want to change the possition. Returns: Usual COM result code: S_OK RPTSVC_E_NO_UNIT_LIMIT Can not find UnitLimit in Attribute RPTSVC_E_NOT_DERIVED_ELEMENT The de0 is not a derived element RPTSVC_E_DE0_NOT_MANAGED The de0 is not a managed derived element (embedded object) RPTSVC_E_DERIVED_ELEMENT_NOT_FOUND The de user wants to update can not be found

---