Supported Bean: RWBean
WebBean
and ObjectBean
interfaces.
The main methods it provides in this interface are:
Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_RW (2048)
Events
addContolToGrid | ||||
Event that adds control to document template |
2048085 | |||
controlDataFilterMode | An integer mode from EnumWebControlDataFilterModes |
2048187 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_DATA_FILTER_MODE |
|
ctlAutoSync |
2048139 | |||
ctlDatasetTargetID | Control dataset target ID |
2048259 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATASET_TARGET_ID |
|
ctlKey | Control key |
2048130 | ||
ctlMultiselect | Specifies control multi-select option |
2048120 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_MULTISELECT |
|
ctlShowAll | Control Show All option |
2048125 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SHOW_ALL |
|
ctlShowTotal |
2048169 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SHOW_TOTAL |
||
ctlTarget | Control target key |
2048129 | ||
ctlTargetStr | A string containing a list of control target keys separated by
EnumRWBeanEvents.ITEM_SEPARATOR symbol |
2048116 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_KEY_STR |
|
ctlTopMost | Select top most element in action control in grid |
2048298 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SELECT_TOPMOST |
|
gridKey | Section key. |
2048007 | ||
infowinTarget |
2048284 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_INFOWIN_TARGET |
||
objectId | Object ID. |
2048001 | ||
objectType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
targetType | Control dataset type |
2048260 | ||
addControl | ||||
Event that adds control to document |
2048068 | |||
*ctlKey | Object key. |
2048012 | ||
*ctlType | Control type (see EnumDSSXMLRWControlType ) |
2048113 | ||
*left | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
*sKey | Section key. |
2048007 | ||
*top | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
ctlAutoSync |
2048139 | |||
ctlGroupbys |
2048206 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_GROUPBY_KEYS |
||
ctlMultiselect | Specifies control multi-select option |
2048120 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_MULTISELECT |
|
ctlNodeKey |
2048205 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_NODE_KEY |
||
ctlOrientation | Specifies control orientation (see EnumRWOrientation ) |
2048121 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_ORIENTATION |
|
ctlShowAll | Control Show All option |
2048125 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SHOW_ALL |
|
ctlSrcId | Control source object ID |
2048114 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_ID |
|
ctlSrcType | Control source object type |
2048115 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_TYPE |
|
ctlStyle | Control style (see EnumRWControlStyle ) |
2048119 | ||
ctlTargets | Control target key |
2048129 | ||
ctlTargetStr | A string containing a list of control target keys separated by
EnumRWBeanEvents.ITEM_SEPARATOR symbol |
2048116 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_KEY_STR |
|
height | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
name | Object name. |
2048020 | ||
width | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
zIndex | The z-index. |
2048100 | ||
addDataSet | ||||
Associates another data set with the RW document. This event will also trigger an applyNow, i.e. deltas will be submitted to the IServer. |
2048007 | |||
*dsObjectID | Underlying object ID of the data set. |
2048032 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID |
|
*dsType | Underlying object type of the data set
(see EnumDSSXMLObjectTypes ). |
2048033 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_TYPE |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
isDatasetAdded | Whether a dataset has been added. |
2048026 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IS_DATASET_ADDED |
|
isDefault | Whether this is the default. |
2048024 | ||
addDataSetAndGrid | ||||
Event that adds data set to document and then copies the data set template to document template |
2048087 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ADD_DATASET_AND_TEMPLATE |
||
*dsObjectID | Underlying object ID of the data set. |
2048032 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID |
|
*dsType | Underlying object type of the data set
(see EnumDSSXMLObjectTypes ). |
2048033 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_TYPE |
|
*objectKey | Object key. |
2048012 | ||
populateOption | Populate option for populating document template with data set template |
2048135 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POPULATE_OPTION |
|
addDerivedMetric | ||||
Adds a derived metric expression. It is defined within a document, and is associated with a residing data set. The derived metric may be reused with embedded grids or text fields. |
2048040 | |||
*formula | Derived metric formula. |
2048022 | ||
alias | Derived metric alias. |
2048021 | ||
dsID | Data set ID. |
2048031 | ||
isAggFromBase | Whether this is an aggregate from base. |
2048105 |
EnumRWBeanEvents.REPORT_WRITE_EVENT_ARGUMENT_IS_AGGREGATE_FROM_BASE |
|
isTokenStream | Derived Metric event argument to indicate whether argument value is a formula string or token stream xml. |
2048275 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IS_TOKENSTREAM |
|
metricPos | Destination position of the derived metric in the metrics collection. |
2048270 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DERIVED_METRIC_POSITION |
|
nodeKey | Target object key. |
2048066 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_OBJECT_KEY |
|
addDocumentView | ||||
2048141 | ||||
*documentViewIndex |
2048235 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_INDEX |
||
*documentViewName |
2048236 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_NAME |
||
*orientation |
2048240 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_ORIENTATION |
||
*resolutionX |
2048237 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_RESOLUTION_X |
||
*resolutionY |
2048238 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_RESOLUTION_Y |
||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
density |
2048239 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_DENSITY |
||
addGroup | ||||
Event to add a new group. |
2048002 | |||
*gObjectID | Group object ID. |
2048004 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_GROUP_OBJECT_ID |
|
*gObjectType | Group object type (see EnumDSSXMLObjectTypes ). |
2048005 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_GROUP_OBJECT_TYPE |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
beforeKey | Key of the object coming before the target. |
2048036 | ||
dataSetID | Data set ID. |
2048031 | ||
fsKey | Footer section key. |
2048039 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FOOTER_SECTION_KEY |
|
fssKey | Footer subsection key. |
2048040 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FOOTER_SUBSECTION_KEY |
|
gKey | Group key. |
2048006 | ||
gObjectSubtype | Object subtype
(see EnumDSSXMLObjectSubTypes ). |
2048106 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_GROUP_OBJECT_SUBTYPE |
|
hsKey | Header section key. |
2048037 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_HEADER_SECTION_KEY |
|
hssKey | Header subsection key. |
2048038 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_HEADER_SUBSECTION_KEY |
|
addHyperLink | ||||
2048098 | ||||
*idx |
4239 | |||
anyOtherPrompts |
4252 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_ANY_OTHER_PROMPTS |
||
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
displayText | allow users to subcribe a subscripiton 1 means allow, 0 means deny |
4241 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ALLOW_USER_SUBSCRIBE |
|
isDefault |
4240 | |||
linkType | the associated user list for a subscription, this is a String including multiple user's name, user's id and user's ACL for example 54F3D26011D2896560009A8E67019608~199~Administrator E96A7B6911D4BBCE10004694316DE8A4~199~Barbara Aoter |
4242 | ||
objKey | Object key. |
2048012 | ||
promptAnswers |
4247 | |||
selectorOptions | Indicates whether to copy the selector's selections when link drilling from one document to another. The options are: - 0 - Do not pass selector values - 1 - Pass selector values - match selectors by ID - 2 - Pass selector values - match selectors by name |
4257 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_SELECTOR_OPTIONS |
|
targetID |
4244 | |||
targetSubType |
4246 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_TARGET_SUBTYPE |
||
targetType |
4245 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_TARGET_TYPE |
||
url | An integer that represents the view modes to add to the available view media property |
4243 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ADD_AVAILABLE_VIEW_MODES |
|
addLayout | ||||
2048094 | ||||
beforeKey | Key of the object coming before the target. |
2048036 | ||
name | Object name. |
2048020 | ||
sectionKey | Section key. |
2048007 | ||
addObjectDataSetTemplate | ||||
Event to add a data set template. |
2048055 | |||
*dsID | Data set ID. |
2048031 | ||
*oKey | Object key. |
2048012 | ||
*sKey | Section key. |
2048007 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
displayMode | Event argument template display mode
(see EnumDSSXMLDisplayMode ). |
2048025 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TEMPLATE_DISPLAY_MODE |
|
ht | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
linked |
2048158 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ADD_DATASET_TEMPLATE_AS_LINKED |
||
lPos | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
name | Object name. |
2048020 | ||
tPos | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
viewTemplate | Whether to use the view template data set. When creating a data set template, this argument if true will add only the data set objects as specified in the view template, otherwise all objects (e.g. metrics, attributes) are added from the data set. True by default. |
2048098 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_VIEW_TEMPLATE |
|
wd | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
zIndex | The z-index. |
2048100 | ||
addObjectHtml | ||||
Event to add a new HTML container object. |
2048097 | |||
*htmlType | Governs the HTML container resolution. A HTML type of 0 will resolve
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_HTML_URL ,
while a type of 1 will resolve EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_HTML_TEXT . |
2048161 | ||
*oKey | Object key. |
2048012 | ||
*sKey | Section key. |
2048007 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
halign | Formatting property horizontal alignment. |
2048099 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HORIZONTAL_ALIGN |
|
height | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
htmlText |
2048142 | |||
htmlURL |
2048141 | |||
lPos | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
name | Object name. |
2048020 | ||
tPos | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
width | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
zIndex | The z-index. |
2048100 | ||
addObjectImage | ||||
Adds a new image source by URL. |
2048018 | |||
*oKey | Object key. |
2048012 | ||
*sKey | Section key. |
2048007 | ||
*url | Image url. |
2048019 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
ht | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
lPos | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
name | Object name. |
2048020 | ||
tPos | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
urlType | Image URL Type |
2048295 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IMAGE_URL_TYPE |
|
wd | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
zIndex | The z-index. |
2048100 | ||
addObjectLine | ||||
Event for adding a line. |
2048031 | |||
*left | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
*oKey | Object key. |
2048012 | ||
*sKey | Section key. |
2048007 | ||
*top | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
height | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
name | Object name. |
2048020 | ||
orientation | Argument indicating line orientation. |
2048061 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LINE_ORIENTATION |
|
width | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
zIndex | The z-index. |
2048100 | ||
addObjectShape | ||||
Event to add a new shape object. |
2048043 | |||
*left | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
*oKey | Object key. |
2048012 | ||
*sKey | Section key. |
2048007 | ||
*top | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
*type | Event argument shape type
(see EnumDSSXMLShapeType ). |
2048067 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
height | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
name | Object name. |
2048020 | ||
width | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
zIndex | The z-index. |
2048100 | ||
addObjectTemplate | ||||
Adds a template object to the section specified. If the dataset is unspecified, it will be associated with the primary dataset. |
2048017 | |||
*oKey | Object key. |
2048012 | ||
*sKey | Section key. |
2048007 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
displayMode | Event argument template display mode
(see EnumDSSXMLDisplayMode ). |
2048025 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TEMPLATE_DISPLAY_MODE |
|
dsID | Data set ID. |
2048031 | ||
ht | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
lPos | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
name | Object name. |
2048020 | ||
tPos | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
wd | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
zIndex | The z-index. |
2048100 | ||
addObjectText | ||||
Event to add a new text object. |
2048003 | |||
*oKey | Object key. |
2048012 | ||
*sKey | Section key. |
2048007 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
expr | Label value. |
2048008 | ||
halign | Formatting property horizontal alignment. |
2048099 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HORIZONTAL_ALIGN |
|
height | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
lPos | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
name | Object name. |
2048020 | ||
tPos | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
width | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
zIndex | The z-index. |
2048100 | ||
addPanel | ||||
Event that adds panel to the panel stack |
2048072 | |||
*pKey | Panel key |
2048117 | ||
*psKey | Section key. |
2048007 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
addPanelStack | ||||
Event that adds panel stack |
2048070 | |||
*pKey | Panel key |
2048117 | ||
*psKey | Object key. |
2048012 | ||
*sKey | Section key. |
2048007 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
height | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
lPos | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
name | Object name. |
2048020 | ||
tPos | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
width | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
zIndex | The z-index. |
2048100 | ||
addShortcutMetric | ||||
Event to add shortcut metric
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_TYPE (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_KEY
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TREE_TYPE
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FUNCTION_TYPE (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FUNCTION_TYPE2
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNITS_COLLECTION |
2048148 | |||
*datasetID | Underlying object ID of the data set. |
2048032 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID |
|
*datasetType | Underlying object type of the data set
(see EnumDSSXMLObjectTypes ). |
2048033 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_TYPE |
|
*functionType | Indicates the main function type in EnumRWBeanEvents.REPORT_WRITER_EVENT_ADD_SHORTCUT_METRIC . This argument is required. |
2048249 | ||
functionType2 | Indicates the optional second function type in EnumRWBeanEvents.REPORT_WRITER_EVENT_ADD_SHORTCUT_METRIC |
2048250 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FUNCTION_TYPE2 |
|
nodeKey | Object key. |
2048012 | ||
treeType |
2048195 | |||
unitsCollection | Indicates the units collection in EnumRWBeanEvents.REPORT_WRITER_EVENT_ADD_SHORTCUT_METRIC ,
with format of DSSIDEnumViewBeanEvents.UNIT_PROPERTY_SEPARATOR EnumDSSXMLObjectTypes EnumViewBeanEvents.MULTIPLE_UNITS_SEPARATOR ; |
2048251 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNITS_COLLECTION |
|
addSubsection | ||||
Event to add a subsection. |
2048015 | |||
*sKey | Section key. |
2048007 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
baseKey | Base key of subsection. |
2048101 | ||
ssKey | Subsection key. |
2048041 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSECTION_KEY |
|
where | Location is either "after" or "before". |
2048102 | ||
addTransactionChanges | ||||
Event to update an RW Instance with transaction changes
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TRANSACTION_STRING (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048135 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ADD_TRANSACTION_CHANGES |
||
*transactionString | XML String containing the transactcion changes to be applied to an RW instance |
2048227 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TRANSACTION_STRING |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
advancedSort | ||||
2048158 | ||||
*nodeKey | Object key. |
2048012 | ||
*subTotalsPos |
2048191 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBTOTALS_POSITION |
||
*treeType |
2048195 | |||
sortKeys | Sort keys separated by unit_separator |
2048271 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ADVANCED_SORT_KEYS |
|
applyAtrributeRemapping | ||||
Event to apply attribute re-map
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_DATASET_ID
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SOURCE_ATT_ID
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_ATT_ID (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SOURCE_ATT_NAME
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_ATT_NAME |
2048154 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_APPLY_ATTRIBUTE_REMAPPING |
||
*datasetID | Underlying object ID of the data set. |
2048032 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID |
|
*sourceAttID |
2048262 | |||
sourceAttName |
2048264 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SOURCE_ATT_NAME |
||
targetAttID |
2048263 | |||
targetAttName |
2048265 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_ATT_NAME |
||
targetDatasetID |
2048266 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_DATASET_ID |
||
applyChangesOnCollectData | ||||
2048022 |
|
|||
applyGraphControlAction | ||||
Event that sets current elements for control on graph |
2048082 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_APPLY_GRAPH_CONTROL_ACTION |
||
*gridKey | Section key. |
2048007 | ||
*sliceID | Graph slice ID |
2048124 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
*x | Cursor X coordinate |
2048122 | ||
*y | Cursor Y coordinate |
2048123 | ||
axesBitMap | Template access bit map |
2048126 | ||
ctlTargetStr | A string containing a list of control target keys separated by
EnumRWBeanEvents.ITEM_SEPARATOR symbol |
2048116 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_KEY_STR |
|
ctrlKeys | A string containing a list of control keys separated by
EnumRWBeanEvents.ITEM_SEPARATOR symbol |
2048225 | ||
usePartDisplay | Indicates whether partial display can be used for event |
2048138 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_PARTIAL_DISPLAY |
|
applyNow | ||||
Triggers an apply changes call. Useful after sending back a large of events,
which utilize the |
2048014 | |||
applySegment | ||||
Event to apply an existing segment to a document |
2048163 | |||
*segmentID | the associated user list for a subscription, this is a String including multiple user's name, user's id and user's ACL for example 54F3D26011D2896560009A8E67019608~199~Administrator E96A7B6911D4BBCE10004694316DE8A4~199~Barbara Aoter |
2048276 | ||
nodeKey | Object key. |
2048012 | ||
unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyTheme | ||||
Event to apply document theme
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_THEME_ID
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IS_LINK |
2048170 | |||
*themeID | The theme id to be applied |
2048292 | ||
isLink | Apply theme in link style or copy style |
2048293 | ||
keys | List of keys, delimited by |
2048076 | ||
cancelRepromptRequest | ||||
Event for canceling a reprompt request. |
2048028 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_CANCEL_REPROMPT_REQUEST |
||
cancelRequest | ||||
Event for canceling the request. |
2048027 | |||
removeMessage | Indicating whether to remove message from inbox when cancel request |
2048297 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REMOVE_MESSAGE |
|
changeTemplateOrigin | ||||
Event to convert a given GridGraph object from being an embedded object (that can be modified) to a link to an existing dataset (and thus cannot be modified) |
2048107 | |||
*oKey | Object key. |
2048012 | ||
dataSetID | Data set ID. |
2048031 | ||
linked |
2048158 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ADD_DATASET_TEMPLATE_AS_LINKED |
||
clearHyperLinks | ||||
2048113 | ||||
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
objKey | Object key. |
2048012 | ||
openInNewWindow |
4250 | |||
configureExport | ||||
This event sets up the export settings for export to PDF/Excel. Note that the event does just sets up the web objects with the settings specified. The settings are not persisted on IServer in any way. |
2048062 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_CONFIGURE_EXPORT_SETTINGS |
||
enableFooter |
2048305 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_FOOTER |
||
enableHeader |
2048304 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_HEADER |
||
exportExecutionMode | Execution mode
(see EnumRWExecutionModes ). |
2048092 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTION_MODE |
|
htmlDelayTime |
2048307 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_HTMLCONTAINER_DELAY_TIME |
||
mode | Specifies the export mode.
Should be a value from EnumRWExportModes |
2048095 | ||
overviewViz |
2048306 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_OVERVIEW |
||
pageOrientation |
2048303 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PAGEORIENTATION |
||
paperHeight |
2048301 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PAPERHEIGHT |
||
paperWidth |
2048302 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PAPERWIDTH |
||
pdfPwd |
2048308 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PASSWORD |
||
range |
2048159 | |||
configureExport | ||||
Event that changes the dataset used by a GridGraph unit |
2048063 | |||
dsID | Data set ID. |
2048031 | ||
objKey | Object key. |
2048012 | ||
copyObject | ||||
Copies an object unit along with its properties. May optionally specify a new position and section. |
2048036 | |||
*newKey | Target object key. |
2048066 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_OBJECT_KEY |
|
*srcKey | Object key. |
2048012 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
lPos | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
sKey | Section key. |
2048007 | ||
tPos | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
copyToClipboard | ||||
Event to copy the current selection to the clipboard. |
2048045 | |||
*srcKey | Object key. |
2048012 | ||
cutToClipboard | ||||
Event to cut (as part of a move operation) the current selection to the clipboard. |
2048046 | |||
*srcKey | Object key. |
2048012 | ||
detailsSorts | ||||
Event to configure sorting in the details section. |
2048048 | |||
*sortKey | Sort key. The format of the key is as follows:
EnumRWBeanEvents.SORT_PARAM_SEPARATOR
example:
Consider a case where the section key is K2 where we need to add an
attribute form sort the key would be
K2;99D2A3CB4A51BBB70BB390900E27E213 |
2048044 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_GROUP_BY_SORT_KEY |
|
sortCount | Event argument sorts count. |
2048047 | ||
sortOrder | This is either EnumRWBeanEvents.SORT_ORDER_ASCENDING or EnumRWBeanEvents.SORT_ORDER_DESCENDING |
2048045 | ||
drill | ||||
Event to execute a grid drill. |
2048123 | |||
*drillPathKey |
2048197 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DRILL_PATH_KEY |
||
elementList |
2048200 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DRILL_ELEMENT_LIST |
||
objectKey | Object key. |
2048012 | ||
retainParnt |
2048198 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DRILL_RETAIN_PARENT |
||
retainThresh |
2048199 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS |
||
duplicatePanel | ||||
2048117 | ||||
*pKey | Panel key |
2048117 | ||
duplicatePanelStack | ||||
2048116 | ||||
*objectKey | Object key. |
2048012 | ||
*offset |
2048171 | |||
editDerivedMetric | ||||
Event to edit a derive metric. |
2048041 | |||
*alias | Derived metric alias. |
2048021 | ||
*formula | Derived metric formula. |
2048022 | ||
*objectID | Object ID. |
2048001 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
dsID | Data set ID. |
2048031 | ||
isAggFromBase | Whether this is an aggregate from base. |
2048105 |
EnumRWBeanEvents.REPORT_WRITE_EVENT_ARGUMENT_IS_AGGREGATE_FROM_BASE |
|
isTokenStream | Derived Metric event argument to indicate whether argument value is a formula string or token stream xml. |
2048275 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IS_TOKENSTREAM |
|
nodeKey | Target object key. |
2048066 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_OBJECT_KEY |
|
editDocumentView | ||||
2048142 | ||||
*documentViewIndex |
2048235 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_INDEX |
||
*documentViewName |
2048236 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_NAME |
||
*orientation |
2048240 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_ORIENTATION |
||
*resolutionX |
2048237 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_RESOLUTION_X |
||
*resolutionY |
2048238 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_RESOLUTION_Y |
||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
density |
2048239 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_DENSITY |
||
editHyperLink | ||||
2048099 | ||||
*idx |
4239 | |||
anyOtherPrompts |
4252 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_ANY_OTHER_PROMPTS |
||
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
displayText | allow users to subcribe a subscripiton 1 means allow, 0 means deny |
4241 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ALLOW_USER_SUBSCRIBE |
|
isDefault |
4240 | |||
linkType | the associated user list for a subscription, this is a String including multiple user's name, user's id and user's ACL for example 54F3D26011D2896560009A8E67019608~199~Administrator E96A7B6911D4BBCE10004694316DE8A4~199~Barbara Aoter |
4242 | ||
objKey | Object key. |
2048012 | ||
promptAnswers |
4247 | |||
selectorOptions | Indicates whether to copy the selector's selections when link drilling from one document to another. The options are: - 0 - Do not pass selector values - 1 - Pass selector values - match selectors by ID - 2 - Pass selector values - match selectors by name |
4257 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_SELECTOR_OPTIONS |
|
targetID |
4244 | |||
targetSubType |
4246 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_TARGET_SUBTYPE |
||
targetType |
4245 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_TARGET_TYPE |
||
url | An integer that represents the view modes to add to the available view media property |
4243 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ADD_AVAILABLE_VIEW_MODES |
|
editHyperLinks | ||||
2048112 | ||||
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
objKey | Object key. |
2048012 | ||
openInNewWindow |
4250 | |||
editObjectImage | ||||
Edits an image source URL. |
2048019 | |||
*oKey | Object key. |
2048012 | ||
*url | Image url. |
2048019 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
urlType | Image URL Type |
2048295 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IMAGE_URL_TYPE |
|
editObjectLine | ||||
Event for editing a line. |
2048037 | |||
*left | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
*oKey | Object key. |
2048012 | ||
*top | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
height | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
orientation | Argument indicating line orientation. |
2048061 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LINE_ORIENTATION |
|
width | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
editObjectShape | ||||
Event to edit a shape object. |
2048044 | |||
*oKey | Object key. |
2048012 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
height | Formatting property height. |
2048042 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_HEIGHT |
|
left | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
top | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
width | Formatting property width. |
2048043 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_WIDTH |
|
editObjectText | ||||
Used for editing the text value. |
2048013 | |||
*oKey | Object key. |
2048012 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
expr | Label value. |
2048008 | ||
name | Object name. |
2048020 | ||
execute | ||||
Event to execute a Report Writing document.
Note that settings the maxWait value indirectly controls the async parameter
If the value of maxWait is set to 0, it is considered asynchronous execution
WebResultSetInstance.setAsync(boolean) .
This method is also used for converting reports into report writing documents. There are two ways to perform this conversion:
|
2048001 | |||
backgroundExec | Argument indicating whether the RW document to be executed as a background job. |
2048242 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTE_BACKGROUND |
|
convertFromVI | Convert from VI flag |
2048296 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONVERT_FROM_VI |
|
creationFlags | Flags governing report to document creation. See EnumDSSXMLRWEaseCreationFlags . |
2048209 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CREATION_FLAGS |
|
currentViewMedia | Media type |
2048174 | ||
deltaXml | An string present the manipulator deltaXml |
2048202 | ||
doNotUpdateCaches |
2048257 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DO_NOT_UPDATE_CACHES |
||
elementsPromptAnswers | Specifies element prompts' answers in a URL friendly format. |
2048089 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER |
|
enableFooter |
2048305 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_FOOTER |
||
enableHeader |
2048304 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_HEADER |
||
execFlags | Execution flags |
2048003 | ||
executionMode | Execution mode
(see EnumRWExecutionModes ). |
2048092 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTION_MODE |
|
freshExec | Argument indicating whether the RW document to be executed with fresh-execution related execution flags. |
2048060 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REEXECUTE_FRESH |
|
htmlDelayTime |
2048307 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_HTMLCONTAINER_DELAY_TIME |
||
layoutIndex | Argument used to select the layout by index, base 0, to be shown when a dashboard or document is executed |
2048300 | ||
layoutKey | Argument used to select the layout by key to be shown when a dashboard or document is executed |
2048299 | ||
linkAnswers |
2048140 | |||
maxWait | Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely. |
2048093 | ||
messageID | Message ID. |
2048002 | ||
mode | Specifies the export mode.
Should be a value from EnumRWExportModes |
2048095 | ||
objectID | Object ID. |
2048001 | ||
objectName | Object name. |
2048020 | ||
objectsPromptAnswers | Specifies an argument for the new prompt answer for
WebObjectsPrompt in
document drilling. |
2048133 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER |
|
objType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
originMessageID | Specifies the message ID of the original Document (HTML or RW) whose prompt answers are going to be retrieved. |
2048087 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID |
|
overviewViz |
2048306 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_OVERVIEW |
||
pageOrientation |
2048303 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PAGEORIENTATION |
||
paperHeight |
2048301 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PAPERHEIGHT |
||
paperWidth |
2048302 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PAPERWIDTH |
||
pdfPwd |
2048308 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PASSWORD |
||
pollingFreq | Polling frequency. |
2048094 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POLLING_FREQUENCY |
|
prevMsgID |
2048238 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_RESOLUTION_Y |
||
prevMsgID |
2048256 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PREVIOUS_MESSAGE_ID |
||
promptAnswerMode | An integer prompt answer mode from EnumWebPromptAnswerMode |
2048201 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION |
|
promptsAnswerXML | Specifies the prompt answer XML from the original Document (HTML or RW). |
2048088 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML |
|
range |
2048159 | |||
resolveOnly | Argument used to indicate whether use execution resolveOnly flag |
2048309 | ||
rptStateID | Control source object ID |
2048114 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_ID |
|
rptStateID |
2048143 | |||
rptViewMode | View mode
(see EnumWebReportViewMode ). |
4115 | ||
selectorMode | Indicates whether to copy the selector's selections when link drilling from one document to another. Depends on { EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID being passed.
The options are:- 0 - Do not pass selector values - 1 - Pass selector values - match selectors by ID - 2 - Pass selector values - match selectors by name |
2048261 | ||
srcAnswers |
2048215 | |||
templateID | Optional template ID for report to document creation |
2048210 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CREATION_TEMPLATE_ID |
|
useDefAns | Whether to use default prompt answers. |
2048103 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_DEFAULT_PROMPT_ANSWERS |
|
valuePromptAnswers | Specifies an argument for the new prompt answer for
WebConstantPrompt in
document drilling. |
2048132 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER |
|
visMode | Visualization mode. |
2048109 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_MODE |
|
fixState | ||||
Event to discard any errors on the bean, and removes all embedded beans. |
2048051 | |||
formatDerivedMetric | ||||
Event to set the format of the derived metric. |
2048060 | |||
*data | Data argument for edit properties. EBNF definition is as follows: data := property [ITEM_SEPARATOR property] property := key UNIT_SEPARATOR propertySetName UNIT_SEPARATOR name UNIT_SEPARATOR value key propertySetName name value := STRING | EMPTY If the key, propertySetName, or name is omitted, the previous declaration will be used - allowing for a relatively compact representation. For example, consider the data string; A112[UNIT_SEPARATOR]FormattingPosition[UNIT_SEPARATOR]Top[UNIT_SEPARATOR]18[ITEM_SEPARATOR][UNIT_SEPARATOR][UNIT_SEPARATOR]Left[UNIT_SEPARATOR]15 maps to the following two property settings:
and
|
2048035 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SET_UNIT_PROPS_DATA |
|
*objectID | Object ID. |
2048001 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
dsID | Data set ID. |
2048031 | ||
gbSorts | ||||
Normally, adding a new sort entails defining the attribute ID, type and form ID. If these arguments are omitted (i.e. only the section key is specified), the first sort found on the group will have its sort order toggled. |
2048020 | |||
*sortKey | Sort key. The format of the key is as follows:
EnumRWBeanEvents.SORT_PARAM_SEPARATOR
example:
Consider a case where the section key is K2 where we need to add an
attribute form sort the key would be
K2;99D2A3CB4A51BBB70BB390900E27E213 |
2048044 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_GROUP_BY_SORT_KEY |
|
sortCount | Event argument sorts count. |
2048047 | ||
sortOrder | This is either EnumRWBeanEvents.SORT_ORDER_ASCENDING or EnumRWBeanEvents.SORT_ORDER_DESCENDING |
2048045 | ||
gridIncrementalFetch | ||||
2048119 | ||||
*colPosition |
2048182 | |||
*maxColumns |
2048180 | |||
*maxRows |
2048179 | |||
*nodeKey | Object key. |
2048012 | ||
*rowPosition |
2048181 | |||
colMode |
2048268 | |||
rowMode |
2048267 | |||
importDoc | ||||
2048104 | ||||
*objectId | Object ID. |
2048001 | ||
beforeKey | Key of the object coming before the target. |
2048036 | ||
isTemplate | Indicates that imported document is a template |
2048175 | ||
incrementalFetch | ||||
2048110 | ||||
*pos |
2048165 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_INCR_FETCH_POS |
||
incrementalFetchSettings | ||||
2048111 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_INCREMENTAL_FETCH_SETTINGS |
|||
blockSize |
2048168 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_INCR_FETCH_BLOCK_SIZE |
||
enabled |
2048166 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_INCR_FETCH_ENABLED |
||
level |
2048167 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_INCR_FETCH_LEVEL |
||
initializeFromSchedule | ||||
Event for initializing the RW Bean with a schedule. |
2048025 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_INITIALIZE_FROM_SCHEDULE |
||
*triggerID | The trigger ID for scheduling/subscription. |
2048048 | ||
targetID | Target object ID for initializing a RW Bean with Schedule |
2048057 | ||
initializeFromSubscription | ||||
Event for initializing the RW Bean with a subscription. |
2048026 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_INITIALIZE_FROM_SUBSCRIPTION |
||
*subscriptionID | Subscription ID for initializing a RW Bean with Subscription |
2048058 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_ID |
|
linkAtrributes | ||||
Event to link attributes. |
2048169 | |||
*sourceAttID |
2048262 | |||
*sourceFormIDs |
2048286 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SOURCE_FORM_IDS |
||
*targetAttIDs |
2048287 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_ATTRIBUTE_IDS |
||
*targetFormIDs |
2048288 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_FORM_IDS |
||
*unlink |
2048289 | |||
moveGroup | ||||
Event to move a group. |
2048010 | |||
*gKey | Group key. |
2048006 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
beforeKey | Key of the object coming before the target. |
2048036 | ||
moveLayout | ||||
2048095 | ||||
beforeKey | Key of the object coming before the target. |
2048036 | ||
sectionKey | Section key. |
2048007 | ||
moveObject | ||||
Used to move objects (e.g. labels, data fields) to different sections.
May also be used to reposition the object, but it would be better
to use the REPORT_WRITER_EVENT_ARGUMENT_EDIT_PROPERTIES_DATA
event instead. |
2048005 | |||
*oKey | Object key. |
2048012 | ||
*sKey | Section key. |
2048007 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
lPos | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
tPos | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
movePanel | ||||
Event that changes panel order in the panel stack |
2048078 | |||
*direction | Specifies direction for moving a panel within panel stack |
2048118 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MOVE_DIRECTION |
|
*pKey | Panel key |
2048117 | ||
*psKey | Section key. |
2048007 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
numberFormat | ||||
2048121 |
|
|||
currency |
2048184 |
|
||
deltaDecimal |
2048183 |
|
||
objKey |
2048012 |
|
||
percentage |
2048185 |
|
||
thousand |
2048186 |
|
||
pasteFormatting | ||||
Copies properties from the source to the target unit object(s). Target keys are specified in a comma delimited list. |
2048035 | |||
*tgtKeys | Target object key. |
2048066 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_OBJECT_KEY |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
pasteFromClipboard | ||||
Event to paste contents from the clipboard. |
2048047 | |||
*newKey | Target object key. |
2048066 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_OBJECT_KEY |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
lPos | Formatting property left position. |
2048011 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_LEFT_POS |
|
sKey | Section key. |
2048007 | ||
tPos | Formatting property top position. |
2048010 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORMAT_PROPS_TOP_POS |
|
performActionOnControl | ||||
Event to perform an action on an Action Selector
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ACTION_TYPE (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048134 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_PERFORM_ACTION_ON_CONTROL |
||
*actionType | Integer from EnumDSSXMLRWControlActionType |
2048226 | ||
*ctlKey | Control key |
2048130 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
populateTemplateFromDataSet | ||||
Event that populates document template from data set template |
2048088 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_POPULATE_TEMPLATE_FROM_DATASET |
||
*dsObjectID | Underlying object ID of the data set. |
2048032 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID |
|
*dsType | Underlying object type of the data set
(see EnumDSSXMLObjectTypes ). |
2048033 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_TYPE |
|
*objectKey | Object key. |
2048012 | ||
populateOption | Populate option for populating document template with data set template |
2048135 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POPULATE_OPTION |
|
refresh | ||||
Event for refreshing the RW document. |
2048030 | |||
fresh | Argument indicating whether the RW document to be executed with fresh-execution related execution flags. |
2048060 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REEXECUTE_FRESH |
|
ignoreStatus | Don't get the stauts of the message before performing the action |
2048232 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IGNORE_MESSAGE_STATUS |
|
regenerate |
2048143 | |||
rePrompt | Reprompting option for refreshing. |
2048059 | ||
stateID | Indicates the state ID argument that is added handled by the EnumRWBeanEvents.REPORT_WRITER_EVENT_REFRESH event. |
2048283 | ||
removeControlFromGrid | ||||
Event that remove control to document template |
2048120 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_REMOVE_CONTROL_FROM_GRID |
||
ctlKey | Control key |
2048130 | ||
gridKey | Section key. |
2048007 | ||
objectId | Object ID. |
2048001 | ||
objectType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
removeDataSet | ||||
Event to remove a data set from the document. |
2048008 | |||
*dsObjectID | Underlying object ID of the data set. |
2048032 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
dsForce | By default this optional value is set to 0 (false), where a data set will NOT be removed if there are objects that refer to it. If set to 1, the data set will be removed along with any objects that refer to it. |
2048034 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_FORCE |
|
removeDerivedAttributes | ||||
Event to delete derived attributes. |
2048167 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_REMOVE_DERIVED_ATTRIBUTES |
||
*attrs | List of derived attributes to delete. |
2048075 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USER_DERIVED_ATTRIBUTES |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
removeDerivedMetrics | ||||
Event to remove 1 or more derived metrics. |
2048042 | |||
*metrics | List of derived attributes to delete. |
2048075 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USER_DERIVED_ATTRIBUTES |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
removeDocumentView | ||||
2048140 | ||||
*documentViewIndex |
2048235 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_INDEX |
||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
removeGroup | ||||
Event to remove a group. |
2048011 | |||
*gKey | Group key. |
2048006 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
removeLayout | ||||
2048096 | ||||
*sectionKey | Section key. |
2048007 | ||
isCurrent | Indicates that layout being removed is a current layout |
2048176 | ||
removeObject | ||||
Used to remove objects (e.g. labels, data fields). |
2048004 | |||
*oKey | Object key. |
2048012 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
removePanel | ||||
Event that removes panel from the panel stack |
2048074 | |||
*oKey | Object key. |
2048012 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
removePlaceHolders | ||||
Event to remove targeted place holders.
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLACEHOLDER_KEYS_STR |
2048168 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_REMOVE_TARGETED_PLACEHOLDERS |
||
*placeholderKeysStr |
2048285 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLACEHOLDER_KEYS_STR |
||
removeSubsection | ||||
Event to remove a subsection. |
2048016 | |||
*ssKey | Subsection key. |
2048041 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSECTION_KEY |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
removeTheme | ||||
Event to remove document theme
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_THEME_ID
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IS_LINK |
2048171 | |||
keys | List of keys, delimited by |
2048076 | ||
reorderControlGroupBy | ||||
Event to re-order a list of control group by's |
2048118 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_REORDER_CONTROL_GROUP_BY |
||
*finalOrder | Argument used in EnumRWBeanEvents.REPORT_WRITER_EVENT_REORDER_CONTROL_GROUP_BY event.
The argument is string that represents the final control group by order. The format of the string
is a list of group by keys delimited by EnumRWBeanEvents.CONTROL_GROUP_BY_REORDER_SEPARATOR . The event will determine the
'moves' required to achieve this final order. If a wrong/invalid key is sent in the argument, it will be ignored
For example K21!K24!K39 is a valid argument value. |
2048173 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_GROUP_BY_FINAL_ORDER |
|
*orderInstructions | Argument used in the EnumRWBeanEvents.REPORT_WRITER_EVENT_REORDER_CONTROL_GROUP_BY event.
The argument is a collection of control group by order instructions. Each instruction
is a group key and action pair - delimited by a EnumRWBeanEvents.CONTROL_GROUP_BY_REORDER_SEPARATOR . The instructions
are delimited by EnumRWBeanEvents.CONTROL_GROUP_BY_SEPARATOR . The action can either EnumRWBeanEvents.ACTION_MOVE_DOWN or EnumRWBeanEvents.ACTION_MOVE_UP For example: "K21!1,K45!2" will move up the control group by with key K21 and move down the control group by with key K45 |
2048172 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_GROUP_BY_REORDER_INSTRUCTIONS |
|
*unitKey | Object key. |
2048012 | ||
replaceDataSet | ||||
2048131 | ||||
*newDataSetID |
2048217 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_NEW_DATASET_ID |
||
*newDataSetType |
2048219 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_NEW_DATASET_TYPE |
||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
oldDataSetID |
2048216 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OLD_DATASET_ID |
||
oldDataSetType |
2048218 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OLD_DATASET_TYPE |
||
resetSelections | ||||
Event to reset document selections |
2048161 | |||
unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
usePartDisplay | Indicates whether partial display can be used for event |
2048138 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_PARTIAL_DISPLAY |
|
revertToFormatDefaults | ||||
Reverts all formatting properties of specified unit to their default values. |
2048050 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_REVERT_TO_FORMAT_DEFAULTS |
||
*keys | List of keys, delimited by |
2048076 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
rwAddAttributeForm | ||||
Event to add/move attribute form.
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FORM_ID
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_INDEX |
2048126 | |||
*attributeFormID |
2048188 | |||
*index |
2048144 | |||
*objectID | Object ID. |
2048001 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
rwAddDeltaXml | ||||
Event to get deltaXML from client side
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DELTAXML
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW |
2048127 | |||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
deltaXml | An string present the manipulator deltaXml |
2048202 | ||
rwChangeUnitName | ||||
2048155 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_CHANGE_UNIT_DISPLAY_NAME |
|||
*objectID | Object ID. |
2048001 | ||
*objectName | Object name. |
2048020 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
data |
2048262 | |||
objectType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
rwChangeUnsetProps | ||||
Event to change the unset properties of a selector control
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_STATUS (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_COUNT
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW |
2048129 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_CHANGE_UNSET_SELECTOR_PROPERTIES |
||
*ctlKey | Control key |
2048130 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
*unsetStatus | An integer describing status |
2048203 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
unsetCount | An integer describing count |
2048204 | ||
rwPivotWithinTemplate | ||||
Event to pivot a template unit in a grid within the RWD. Only used to
pivot units already in template
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_TYPE can be a list of object types separated by EnumRWBeanEvents.ITEM_SEPARATOR
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID can be a list of object IDs separated by EnumRWBeanEvents.ITEM_SEPARATOR . Leave blank for Metrics TemplateUnit
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_AXIS
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TEMPLATE_POSITION |
2048125 | |||
*templatePosition | Template position |
2048128 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TEMPLATE_POSITION |
|
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
objectID | Object ID. |
2048001 | ||
objectType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
templateAxis |
2048194 | |||
rwShowSubtotals | ||||
2048156 | ||||
*objectID | Object ID. |
2048001 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
clearSubtotalType |
2048273 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CLEAR_SUBTOTAL_TYPE |
||
objectType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
subtotalType |
2048193 | |||
rwUnsetSelectorControl | ||||
Event to change a control to the unset state
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW |
2048128 | |||
*ctlKey | Control key |
2048130 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
rwUpdateRWPropsJson | ||||
RW Event for updating RW Unit properties via a JSON object. |
2048159 | |||
*format |
2048272 |
|
||
*key | Object key. |
2048012 | ||
formatType | Format type (see EnumRWFormatTypes ) |
2048131 | ||
rwUpdateTemplateUnits | ||||
2048157 | ||||
*objectID | Object ID. |
2048001 | ||
*templateAction |
2048269 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TEMPLATE_ACTION |
||
*templatePosition | Template position |
2048128 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TEMPLATE_POSITION |
|
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
objectType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
templateAxis |
2048194 | |||
saveAs | ||||
Event to save the document. |
2048006 | |||
*name | The new save-as name. |
2048014 | ||
*parentFolder | Object id of the parent folder. |
2048013 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SAVE_AS_PARENT_FOLDER_ID |
|
desc | Save-as description. |
2048015 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SAVE_AS_DESCRIPTION |
|
dFlags | Display flags
(see EnumDSSXMLDisplayMode ). |
2048017 | ||
sFlags | Save-as flags
(see EnumDSSXMLReportSaveAsFlags ). |
2048016 | ||
saveAssociatedSchedules | ||||
Event to update associated schedules |
2048153 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_UPDATE_ASSOCIATED_SCHEDULES |
||
*nonSchedulable | Flags indicating non-schedulable |
2048254 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_NON_SCHEDULABLE |
|
scheduleList | assoiciated schedule list |
2048255 | ||
saveAssociatedUsers | ||||
Specifies an event to save associated users |
2048162 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_UPDATE_ASSOCIATED_USERS |
||
*allowUsersSubscribe | Flags indicating allow or deny user to subscribe, 1 means allow, 0 means deny |
2048277 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ALLOW_USER_SUBSCRIBE |
|
userList | the associated user list for a subscription, this is a String including multiple user's name, user's id and user's ACL for example 54F3D26011D2896560009A8E67019608~199~Administrator E96A7B6911D4BBCE10004694316DE8A4~199~Barbara Aoter |
2048276 | ||
saveEmailSubscription | ||||
Event for saving subscription. |
2048024 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SAVE_EMAIL_SUBSCRIPTION |
||
addressID | Address ID for email subscription. |
2048051 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID |
|
addressValues | Address values for email subscription. |
2048052 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES |
|
customMsg | Custom message for email subscription. |
2048054 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE |
|
deviceID | Device ID for email subscription. |
2048056 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_DEVICE_ID |
|
emailSubject | Subject for email subscription. |
2048053 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT |
|
fModeExAll | Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1"). |
2048104 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_ALL_PAGES |
|
fModeSep | Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports. |
2048107 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_SEPARATED_PAGES |
|
format | Event argument subscription format state. |
2048062 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_FORMAT_STATE |
|
locKey | Location key for file and print export. |
2048080 | ||
sendNow | Send now flag for email subscription. |
2048055 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW |
|
triggerID | The trigger ID for scheduling/subscription. |
2048048 | ||
zip | Argument indicating whether to zip contents of subscription. |
2048063 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_ZIP_CONTENTS |
|
saveFileSubscription | ||||
Save a scheduled file export. |
2048058 | |||
*triggerID | The trigger ID for scheduling/subscription. |
2048048 | ||
addressValues | Address values for email subscription. |
2048052 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES |
|
customMsg | Custom message for email subscription. |
2048054 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE |
|
fileName | File name for file export. |
2048081 | ||
fModeExAll | Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1"). |
2048104 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_ALL_PAGES |
|
fModeSep | Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports. |
2048107 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_SEPARATED_PAGES |
|
format | Event argument subscription format state. |
2048062 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_FORMAT_STATE |
|
locKey | Location key for file and print export. |
2048080 | ||
notifyAddressID | Subscription notification is sent to this existing address. |
2048090 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID |
|
notifyAddressValue | Subscription notification is sent to this new address. If this is supplied, it
takes precedence over
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID . |
2048091 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE |
|
notifyDeviceID | Subscription notification device ID. |
2048096 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID |
|
sendNow | Send now flag for email subscription. |
2048055 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW |
|
zip | Argument indicating whether to zip contents of subscription. |
2048063 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_ZIP_CONTENTS |
|
savePrintSubscription | ||||
Save a scheduled print export. |
2048059 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SAVE_PRINT_SUBSCRIPTION |
||
*triggerID | The trigger ID for scheduling/subscription. |
2048048 | ||
addressValues | Address values for email subscription. |
2048052 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES |
|
copies | Copies for print schedule. |
2048082 | ||
customMsg | Custom message for email subscription. |
2048054 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE |
|
fModeExAll | Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1"). |
2048104 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_ALL_PAGES |
|
fModeSep | Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports. |
2048107 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_SEPARATED_PAGES |
|
format | Event argument subscription format state. |
2048062 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_FORMAT_STATE |
|
isCollated | Whether printing is to be collated. |
2048084 | ||
isPortrait | Whether print page is in portrait or landscape mode. |
2048083 | ||
locKey | Location key for file and print export. |
2048080 | ||
notifyAddressID | Subscription notification is sent to this existing address. |
2048090 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID |
|
notifyAddressValue | Subscription notification is sent to this new address. If this is supplied, it
takes precedence over
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID . |
2048091 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE |
|
notifyDeviceID | Subscription notification device ID. |
2048096 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID |
|
printAll | Whether to print all pages. |
2048097 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_PRINT_ALL |
|
rangeEnd | Stop printing at this page.
Also see EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_RANGE_START . |
2048086 | ||
rangeStart | Start printing from this page.
Also see EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_RANGE_END . |
2048085 | ||
sendNow | Send now flag for email subscription. |
2048055 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW |
|
saveSchedule | ||||
Event for saving schedule. |
2048023 | |||
*triggerID | The trigger ID for scheduling/subscription. |
2048048 | ||
execFlags | Schedule execution flags. |
2048108 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SCHEDULE_EXECUTION_FLAGS |
|
mobile |
5120016 | |||
overWrite | Specifies whether any existing schedule for the same RW Object (and trigger) should be overwritten. |
2048050 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SCHEDULE_OVERWRITE |
|
reuseMessage | Specifies whether to reuse the message ID while scheduling |
2048049 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE |
|
saveToInbox | ||||
Event for adding RW message to Inbox. |
2048038 | |||
setAsDefaultProperties | ||||
Configures specified unit object properties as system default. New units are created with these defaults. |
2048034 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_AS_DEFAULT_PROPERTIES |
||
*unitKey | Object key. |
2048012 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setAssociatedRWNodes | ||||
Event to set associated nodes to a RWNode for specified manipulation category
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_KEY (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ASSOCIATED_NODES
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MANIPULATION_CATEGORY (required) |
2048143 | |||
*manipulationCategory | Argument specifying the manipulation category for the associated nodes |
2048247 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MANIPULATION_CATEGORY |
|
*nodeKey | Object key. |
2048012 | ||
associatedNodes | Argument specifying associated nodes to be set |
2048248 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ASSOCIATED_NODES |
|
setContolAllAlias | ||||
Event that sets alias to be displayed for control's Select All option |
2048086 | |||
*ctlKey | Control key |
2048130 | ||
ctlAllAlias | Alias to used for control Select All option. |
2048134 | ||
setContolAutoSync | ||||
2048092 | ||||
*ctlKey | Control key |
2048130 | ||
ctlAutoSync |
2048139 | |||
setContolMouseOverAction | ||||
Event that sets control mouse over action |
2048089 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CONTROL_MOUSE_OVER_ACTION |
||
*ctlKey | Control key |
2048130 | ||
ctlMouseOverAction | Control mouse option action (for Flash); |
2048136 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CTL_MOUSE_OVER_ACTION |
|
setContolMultiselect | ||||
Evnet that sets control multi-select option |
2048081 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CONTROL_MULTISELECT |
||
*ctlKey | Control key |
2048130 | ||
*ctlMultiselect | Specifies control multi-select option |
2048120 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_MULTISELECT |
|
setContolShowAll | ||||
Event that sets control show all option |
2048083 | |||
*ctlKey | Control key |
2048130 | ||
*ctlShowAll | Control Show All option |
2048125 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SHOW_ALL |
|
setContolSource | ||||
Event that sets control source |
2048069 | |||
ctlKey | Control key |
2048130 | ||
ctlSrcId | Control source object ID |
2048114 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_ID |
|
ctlSrcType | Control source object type |
2048115 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_TYPE |
|
setContolStyle | ||||
Event that sets control style |
2048079 | |||
*ctlKey | Control key |
2048130 | ||
*ctlStyle | Control style (see EnumRWControlStyle ) |
2048119 | ||
setContolTargets | ||||
Event that sets control targets |
2048067 | |||
controlDataFilterMode | An integer mode from EnumWebControlDataFilterModes |
2048187 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_DATA_FILTER_MODE |
|
ctlAttributesID |
2048278 | |||
ctlAttributesType |
2048279 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CANDIDATE_TYPE |
||
ctlGroupbys |
2048206 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_GROUPBY_KEYS |
||
ctlKey | Control key |
2048130 | ||
ctlTargets | Control target key |
2048129 | ||
ctlTargetStr | A string containing a list of control target keys separated by
EnumRWBeanEvents.ITEM_SEPARATOR symbol |
2048116 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_KEY_STR |
|
enableSubmissionOrder | A string containing a list of control texts separated by
EnumRWBeanEvents.ITEM_SEPARATOR symbol |
2048280 | ||
targetType | Control dataset type |
2048260 | ||
setContolType | ||||
Event that sets control type |
2048080 | |||
*ctlKey | Control key |
2048130 | ||
*ctlType | Control type (see EnumDSSXMLRWControlType ) |
2048113 | ||
setControlActions | ||||
Event to set the available actions on an Action Seletor
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ACTION_TYPE (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048136 | |||
*actionType | Integer from EnumDSSXMLRWControlActionType |
2048226 | ||
*ctlKey | Control key |
2048130 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setControlDataFilterMode | ||||
Event to set a control's data filter mode (control group by mode) |
2048122 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CONTROL_DATA_FILTER_MODE |
||
*controlDataFilterMode | An integer mode from EnumWebControlDataFilterModes |
2048187 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_DATA_FILTER_MODE |
|
*ctlKey | Control key |
2048130 | ||
setControlDisplayText | ||||
Event to set display text for an Action Selector
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_DISPLAY_TEXT (required=0)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048138 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CONTROL_DISPLAY_TEXT |
||
*ctlKey | Control key |
2048130 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
displayText | The display text for the action selector |
2048234 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_DISPLAY_TEXT |
|
setControlElements | ||||
Event that sets control selected elements |
2048084 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_SELECTOR_CONTROL_ELEMENTS |
||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
ctlKey | Control key |
2048130 | ||
ctlTargetStr | A string containing a list of control target keys separated by
EnumRWBeanEvents.ITEM_SEPARATOR symbol |
2048116 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_KEY_STR |
|
currentIncludeState | Indicates a boolean value specifying whether the control selection should be inclusive |
2048224 | ||
elemList | List of selected elements |
2048127 | ||
targetType | Control dataset type |
2048260 | ||
unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
usePartDisplay | Indicates whether partial display can be used for event |
2048138 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_PARTIAL_DISPLAY |
|
setControlExpression | ||||
Event to set the current expression of a control.
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_TYPE (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPRESSION_FUNCTION (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPRESSION_FUNCTION_TYPE (required)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPRESSION_CONSTANTS
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_TYPE
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_PARTIAL_DISPLAY |
2048132 | |||
*ctlKey | Control key |
2048130 | ||
*expFunction | Indicates an int from EnumDSSXMLFunction or EnumWebMRPFunction |
2048220 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPRESSION_FUNCTION |
|
*expFunctionType | Indicates an int from EnumWebFunctionType |
2048223 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPRESSION_FUNCTION_TYPE |
|
*objectID | Object ID. |
2048001 | ||
*objType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
dataType | Indicates a data type from EnumDSSXMLDataType |
2048222 | ||
expConstants | Indicates a set of constants to be used in an expression. Separated by EnumRWBeanEvents.ITEM_SEPARATOR |
2048221 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPRESSION_CONSTANTS |
|
usePartDisplay | Indicates whether partial display can be used for event |
2048138 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_PARTIAL_DISPLAY |
|
setControlForms | ||||
Event to set control custom forms
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_FORMS (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048146 | |||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
forms | Argument specifying list of forms separated by EnumRWBeanEvents.ITEM_SEPARATOR |
2048243 | ||
setControlFormsDelimiter | ||||
Event to set control custom forms delimiter
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_FORMS_DELIMITER (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048144 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CONTROL_FORMS_DELIMITER |
||
*delimiter | Argument specifying form delimiter string |
2048245 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_FORMS_DELIMITER |
|
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setControlFormsDisplayType | ||||
Event to set control forms display type
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_FORMS_DISPLAY_TYPE (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048145 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CONTROL_FORMS_DISPLAY_TYPE |
||
*displayType | Argument specifying display type from EnumDSSXMLControlAttributeFormDisplayOption |
2048244 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_FORMS_DISPLAY_TYPE |
|
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setControlIsInList | ||||
Event to set the current expression of a control.
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IS_IN_LIST (required=1} |
2048133 | |||
*ctlKey | Control key |
2048130 | ||
*include | Indicates a boolean value specifying whether the control selection should be inclusive |
2048224 | ||
objectID | Object ID. |
2048001 | ||
objType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
setControlShowTotal | ||||
2048114 | ||||
*ctlKey | Control key |
2048130 | ||
showTotal |
2048169 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SHOW_TOTAL |
||
setControlSorts | ||||
Event to set the sorts to be applied to a control
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SORT_ORDER
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SORTS_COUNT
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SORTS |
2048147 | |||
*ctlKey | Control key |
2048130 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
ctlSorts | Argument specifying sort parameters delimited by EnumRWBeanEvents.ITEM_SEPARATOR |
2048246 | ||
sortCount | Event argument sorts count. |
2048047 | ||
sortOrder | This is either EnumRWBeanEvents.SORT_ORDER_ASCENDING or EnumRWBeanEvents.SORT_ORDER_DESCENDING |
2048045 | ||
setControlTexts | ||||
Event to set text on a text selector.
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_TEXTS (required=0)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_PARTIAL_DISPLAY (required=0) |
2048165 | |||
*ctlKey | Control key |
2048130 | ||
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
ctlTexts | Derived Metric event argument to indicate whether argument value is a formula string or token stream xml. |
2048275 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IS_TOKENSTREAM |
|
usePartDisplay | Indicates whether partial display can be used for event |
2048138 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_PARTIAL_DISPLAY |
|
setControlTotalPosition | ||||
2048115 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CONTROL_TOTAL_POSITION |
|||
*ctlKey | Control key |
2048130 | ||
TotalPosition |
2048170 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_TOTAL_POSITION |
||
setCurrentDocumentView | ||||
2048139 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CURRENT_DOCUMENT_VIEW |
|||
*documentViewIndex |
2048235 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DOCUMENT_VIEW_INDEX |
||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setCurrentGroupByElement | ||||
Event for setting the current group by elements from a navigation tree selection. Note that this always triggers an applyNow call. |
2048109 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CURRENT_GROUP_BY_ELEMENTS |
||
*grps | Collection of group elements. Each group element is a group key and
element ID pair - the group key and element ID are delimited by the
EnumRWBeanEvents.UNIT_SEPARATOR , and groups elements are delimited by the
EnumRWBeanEvents.ITEM_SEPARATOR . E.g. |
2048164 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_GROUP_KEY_ELEMENTS |
|
setCurrentGroupByElement | ||||
Event for setting the current group by element. Note that this always triggers an applyNow call. |
2048029 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CURRENT_GROUP_BY_ELEMENT |
||
elementID | Element ID. |
2048078 | ||
flags | Flags controlling group by behavior |
2048252 | ||
gbUnits | Argument used by setCurrentGroupByElement gbUnits |
2048310 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_GROUP_BY_UNITS |
|
gKey | Group key. |
2048006 | ||
setCurrentLayout | ||||
2048093 | ||||
*sectionKey | Section key. |
2048007 | ||
setCurrentPanel | ||||
Event that sets current panel in the panel stack |
2048076 | |||
*pKey | Panel key |
2048117 | ||
*psKey | Section key. |
2048007 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
dirtyKeys | A list of keys of the document units that need to be redisplayed. |
2048178 | ||
unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
setDatasetJoinMode | ||||
2048105 | ||||
*dsObjectID | Underlying object ID of the data set. |
2048032 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID |
|
*isJoinPrimary |
2048155 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IS_JOIN_PRIMARY |
||
setDefaultDataSet | ||||
Designates one of the associated data sets as the default. The default data set is used if the data set is unspecified for operations (e.g. template related) requiring one. |
2048039 | |||
*dataSetID | Data set ID. |
2048031 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setDocumentZoom | ||||
This event is used to set the zoom factor for the document. |
2048091 | |||
*applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
*data | Data argument. data := property [ITEM_SEPARATOR property] property := propertySetName UNIT_SEPARATOR name UNIT_SEPARATOR value propertySetName name value := STRING | EMPTY Compact representation supported - see
|
2048065 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SET_RW_PROPS_DATA |
|
setExecutionMode | ||||
Event to set the execution mode. |
2048061 | |||
executionMode | Execution mode
(see EnumRWExecutionModes ). |
2048092 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTION_MODE |
|
setFilterDetailsFormatting | ||||
Event to set a filter detail format. The object key argument is optional, so if not specified the formatting will be applied to the RW document. |
2048106 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_FILTER_DETAILS_FORMATTING |
||
fKey |
2048156 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FILTER_DETAIL_FORMAT_KEY |
||
fVal |
2048157 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_FILTER_DETAIL_FORMAT_VALUE |
||
oKey | Object key. |
2048012 | ||
setGridGraphDisplayMode | ||||
Event that switches the display mode of the document template object. |
2048090 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_GRID_GRAPH_DISPLAY_MODE |
||
*displayMode | Event argument template display mode
(see EnumDSSXMLDisplayMode ). |
2048025 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TEMPLATE_DISPLAY_MODE |
|
*gridKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
setGridViewFilter | ||||
2048130 | ||||
*filterXML |
2048207 | |||
*objKey | Object key. |
2048012 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
expandXML |
2048274 | |||
usePartDisplay | Indicates whether partial display can be used for event |
2048138 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_PARTIAL_DISPLAY |
|
setGridViewLimit | ||||
2048160 | ||||
*filterXML |
2048207 | |||
*objKey | Object key. |
2048012 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setGroupByDisplayAttrForms | ||||
Event to set control forms display type
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_GROUP_KEY (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_FORMS (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048150 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_GROUPBY_DISPLAY_ATTR_FORMS |
||
*forms | Argument specifying list of forms separated by EnumRWBeanEvents.ITEM_SEPARATOR |
2048243 | ||
*gKey | Group key. |
2048006 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setGroupByDisplayType | ||||
Event to set control forms display type
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_GROUP_KEY (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_FORMS_DISPLAY_TYPE (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048149 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_GROUPBY_DISPLAY_TYPE |
||
*displayType | Argument specifying display type from EnumDSSXMLControlAttributeFormDisplayOption |
2048244 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_FORMS_DISPLAY_TYPE |
|
*gKey | Group key. |
2048006 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setNextCurrentGroupByElement | ||||
Event to set the next current group-by element. |
2048057 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_NEXT_CURRENT_GROUP_BY_ELEMENT |
||
*pageByElementAction | Element action
(see EnumDSSXMLCurrentElementAction ). |
2048079 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ELEMENT_ACTION |
|
setObjectProps | ||||
This is used to edit |
2048009 | |||
*data | Data argument for edit properties. EBNF definition is as follows: data := property [ITEM_SEPARATOR property] property := key UNIT_SEPARATOR propertySetName UNIT_SEPARATOR name UNIT_SEPARATOR value key propertySetName name value := STRING | EMPTY If the key, propertySetName, or name is omitted, the previous declaration will be used - allowing for a relatively compact representation. For example, consider the data string; A112[UNIT_SEPARATOR]FormattingPosition[UNIT_SEPARATOR]Top[UNIT_SEPARATOR]18[ITEM_SEPARATOR][UNIT_SEPARATOR][UNIT_SEPARATOR]Left[UNIT_SEPARATOR]15 maps to the following two property settings:
and
|
2048035 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SET_UNIT_PROPS_DATA |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
applyToAllViews |
2048241 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_TO_ALL_VIEWS |
||
formatType | Format type (see EnumRWFormatTypes ) |
2048131 | ||
usePartDisplay | Indicates whether partial display can be used for event |
2048138 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_PARTIAL_DISPLAY |
|
setPageByStyle | ||||
Event to set the page-by style. |
2048056 | |||
*gKey | Group key. |
2048006 | ||
*pageByStyle | Page-by style. |
2048077 | ||
setRWProps | ||||
Sets properties on the RW document instance. |
2048033 | |||
*data | Data argument. data := property [ITEM_SEPARATOR property] property := propertySetName UNIT_SEPARATOR name UNIT_SEPARATOR value propertySetName name value := STRING | EMPTY Compact representation supported - see
|
2048065 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SET_RW_PROPS_DATA |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setSubsequentActions | ||||
Event to set the subsequent actions on an Action Selector after submit
Arguments:
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSEQUENT_ACTION (required=1)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONFIRM_MESSAGE (required=0)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSEQUENT_ACTION_OBJECT_ID (required=0)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSEQUENT_ACTION_OBJECT_TYPE (required=0)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSEQUENT_ACTION_OBJECT_NAME (required=0)
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0) |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_CONTROL_SUBSEQUENT_ACTIONS |
||
*ctlKey | Control key |
2048130 | ||
*subsequentAction | Integer from EnumDSSXMLRWControlSubsequentAction |
2048228 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSEQUENT_ACTION |
|
*unitKeyContext | Specifies an argument used to identify a RW unit. |
2048137 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
confirmMessage | String message will be displayed after user click submit and the submit is successful |
2048231 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONFIRM_MESSAGE |
|
objectID | The dssID of the document or report to be executed after submit |
2048229 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSEQUENT_ACTION_OBJECT_ID |
|
objectName | The object name of the document or report to be executed after submit |
2048233 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSEQUENT_ACTION_OBJECT_NAME |
|
objectType | Integer from EnumDSSXMLObjectTypes |
2048230 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSEQUENT_ACTION_OBJECT_TYPE |
|
setTemplateUnitProps | ||||
2048164 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_TEMPLATE_UNIT_PROPS |
|||
*nodeKey | Object key. |
2048012 | ||
*propStr | Argument specifying the propertySet, the property name and the desired property value that needs to be set. The format of the argument is: PropertySetName|sep|PropertyName|sep|PropertyValue|sep|"dft" where |sep| is a separator, the constant for which is the last part "dft" is optional. It means changing the property to default value |
4146 | ||
*unitID | Object ID. |
2048001 | ||
*unitType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
treeType |
2048195 | |||
setViewMediaSettings | ||||
2048108 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_VIEW_MEDIA_SETTINGS |
|||
addModes |
2048290 |
|
||
availableModes |
2048162 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_AVAILABLE_MODES |
||
defaultModes |
2048163 | |||
removeModes |
2048291 |
|
||
setViewProps | ||||
Sets properties on embedded view instances. Although these template
properties may be directed to the ViewBeans (via
( |
2048032 | |||
*data | Data argument. EBNF definition is as follows: data := property [ITEM_SEPARATOR property] property := [templateKey] UNIT_SEPARATOR propertySetName UNIT_SEPARATOR name UNIT_SEPARATOR value templateKey propertySetName name value := STRING | EMPTY If the templateKey, propertySetName, or name is omitted, the previous declaration will be used - allowing for a relatively compact representation. For example, consider the data string - the second declaration omits the templateKey: K21[UNIT_SEPARATOR]ps1[UNIT_SEPARATOR]xxx[UNIT_SEPARATOR]15[ITEM_SEPARATOR][UNIT_SEPARATOR][UNIT_SEPARATOR]yyy[UNIT_SEPARATOR]16 maps to the following two property settings:
and
|
2048064 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SET_VIEW_PROPS_DATA |
|
applyNow | When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true. |
2048018 | ||
setVisualizationMode | ||||
Event that sets visualization mode |
2048065 | |||
layoutId | Indicates the layout ID |
2048212 | ||
visualizationMode | Visualization mode. |
2048109 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_MODE |
|
setVisualizationProps | ||||
Event that sets visalization properties |
2048066 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_VISUALIZATION_PROPS |
||
enabled |
2048112 | |||
image | Indicates the visualization's image |
2048211 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_IMAGE |
|
includeMDProps | Indicates whether to include the MD properties on the visualization's data XML |
2048177 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_INCLUDE_MD_PROPERTIES |
|
layoutId | Indicates the layout ID |
2048212 | ||
selectedVisualization | Selected visualization |
2048110 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SELECTED_VISUALIZATION |
|
viewMode | Visualization mode. |
2048109 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_MODE |
|
visProps | Indicates the visualization properties |
2048213 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_PROPERTIES |
|
visualizationList |
2048111 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_LIST |
||
sortGrid | ||||
Event to sort on a grid.
|
2048124 | |||
*axis |
2048194 | |||
*nodeKey | Object key. |
2048012 | ||
*sortType |
2048189 | |||
*subTotalsPos |
2048191 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBTOTALS_POSITION |
||
*treeType |
2048195 | |||
*unitID | Object ID. |
2048001 | ||
*unitType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
elementList | List of selected elements |
2048127 | ||
formID |
2048188 | |||
formType |
2048196 | |||
isAsc |
2048190 | |||
subtotalID |
2048192 | |||
subtotalType |
2048193 | |||
sortsClear | ||||
Event to clear any configured sorting. |
2048049 | |||
*sectionKey | Section key. |
2048007 | ||
toggleDataServeMode | ||||
2048166 | ||||
*dsObjectID | Underlying object ID of the data set. |
2048032 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID |
|
*dsType | Underlying object type of the data set
(see EnumDSSXMLObjectTypes ). |
2048033 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_TYPE |
|
serveMode | Data serve mode. 1 -> In-Memory 2 -> Direct Access |
2048282 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DATA_SERVE_MODE |
|
toggleThresholds | ||||
Event toggle thresholds. |
2048064 |
Notes
* denotes required field.