Supported Bean: GridFormatEditorBean

This class provides the grid formatting editor interface for modifying the looks of the grid currently being displayed to the user.

Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanGridFormatEditor (29)

Application bean type for the Grid Format Editor bean

Events

apply, cancel, changeNumCategory, changeTarget, closeEditor, ok, openEditor, processBorderTab, processCellTab, processFontTab, processNumberTab, setTopLeft, switchTab

apply
Event to execute the main action of the ReportEditor

17003

EnumFrameEditorEvents.WebEventApply
cancel
Equivalent to close.

17005

EnumFrameEditorEvents.WebEventCancel
changeNumCategory
Identifier for the event that allows users to change the number category to be applied on the selected target object. On the default event handler, changing the number category does not actually apply the change on the target object, but just allows to show specific settings for this formatting. The changes will get applied once the user selects the Apply or OK buttons.

29006

EnumGridFormatEditorEvents.WebEventChangeNumberCategory

*numCatPrefix

Identifier for the argument that indicates the prefix to use for identifying the number category selected. This argument is used for prefixing the different possible values of the number category format that can be selected by the user for the current target.
Usage:
To this prefix, the value of the number category to use will be appended. These values are defined on the EnumGridFormatNumberCategory enumeration, such as EnumGridFormatNumberCategory.GridFormatNumberCategoryGeneral, EnumGridFormatNumberCategory.GridFormatNumberCategoryCurrency, etc.

29032

EnumGridFormatEditorEvents.WebEventArgumentNumberCategoryPrefix

axisPos

Identifier for the argument that includes the location of the target object to format. Usage:
The possible values for this argument include strings that specify the axis and position location of the object to be formatted, separated by comma: axis,position.
Valid values for the axis section of the value include those defined on the EnumDSSXMLAxisName enumeration, such as EnumDSSXMLAxisName.DssXmlAxisNameRows, so an argument value defined as 1,2 represents the second element on the rows axis.
If the second element of the string (representing position) is zero, then the axis value indicates which full axis will be formatted, for example, 1,0 represents the row axis.
If the second element of the string is a -1 the code represents a metric, and its position on the array of metrics is indicated on the first element of the value, for example 1,-1 represents the second metric on the grid.
If the second element of the string has as value GridWebFormatHelper.LOCAL_TARGET_ALL_METRICS or GridWebFormatHelper.LOCAL_TARGET_ALL_REPORT then this indicates the formatting object that will be modified.

29002

EnumGridFormatEvents.WebEventArgumentAxisPosition

level

Identifier of the argument that indicates at which level the target object will be modified. Usage:
Possible values for this argument include those defined on the EnumWebFormatType enumeration, such as EnumWebFormatType.WebFormatTypeHeader, EnumWebFormatType.WebFormatTypeGrid, etc.
EnumWebFormatType.WebFormatTypeSubtotalGrid and EnumWebFormatType.WebFormatTypeSubtotalHeader do not apply when modifying metrics.

29003

EnumGridFormatEvents.WebEventArgumentLevel
changeTarget
Identifier for the event that allows users to change the target object to be formatted.

29002

EnumGridFormatEditorEvents.WebEventChangeFormattingTarget

*axisPos

Identifier for the argument that includes the location of the target object to format. Usage:
The possible values for this argument include strings that specify the axis and position location of the object to be formatted, separated by comma: axis,position.
Valid values for the axis section of the value include those defined on the EnumDSSXMLAxisName enumeration, such as EnumDSSXMLAxisName.DssXmlAxisNameRows, so an argument value defined as 1,2 represents the second element on the rows axis.
If the second element of the string (representing position) is zero, then the axis value indicates which full axis will be formatted, for example, 1,0 represents the row axis.
If the second element of the string is a -1 the code represents a metric, and its position on the array of metrics is indicated on the first element of the value, for example 1,-1 represents the second metric on the grid.
If the second element of the string has as value GridWebFormatHelper.LOCAL_TARGET_ALL_METRICS or GridWebFormatHelper.LOCAL_TARGET_ALL_REPORT then this indicates the formatting object that will be modified.

29002

EnumGridFormatEvents.WebEventArgumentAxisPosition

level

Identifier of the argument that indicates at which level the target object will be modified. Usage:
Possible values for this argument include those defined on the EnumWebFormatType enumeration, such as EnumWebFormatType.WebFormatTypeHeader, EnumWebFormatType.WebFormatTypeGrid, etc.
EnumWebFormatType.WebFormatTypeSubtotalGrid and EnumWebFormatType.WebFormatTypeSubtotalHeader do not apply when modifying metrics.

29003

EnumGridFormatEvents.WebEventArgumentLevel
closeEditor
Event to close the ReportEditor

17002

EnumFrameEditorEvents.WebEventClose
ok
Event corresponding to apply and close.

17004

EnumFrameEditorEvents.WebEventOk
openEditor
Event to open the ReportEditor

17001

EnumFrameEditorEvents.WebEventOpen
processBorderTab
Identifier for the event that allows users to submit the indicated changes on the Border properties tab of the editor.

29005

EnumGridFormatEditorEvents.WebEventProcessBorderTabProperties

*axisPos

Identifier for the argument that includes the location of the target object to format. Usage:
The possible values for this argument include strings that specify the axis and position location of the object to be formatted, separated by comma: axis,position.
Valid values for the axis section of the value include those defined on the EnumDSSXMLAxisName enumeration, such as EnumDSSXMLAxisName.DssXmlAxisNameRows, so an argument value defined as 1,2 represents the second element on the rows axis.
If the second element of the string (representing position) is zero, then the axis value indicates which full axis will be formatted, for example, 1,0 represents the row axis.
If the second element of the string is a -1 the code represents a metric, and its position on the array of metrics is indicated on the first element of the value, for example 1,-1 represents the second metric on the grid.
If the second element of the string has as value GridWebFormatHelper.LOCAL_TARGET_ALL_METRICS or GridWebFormatHelper.LOCAL_TARGET_ALL_REPORT then this indicates the formatting object that will be modified.

29002

EnumGridFormatEvents.WebEventArgumentAxisPosition

aColor

29030

EnumGridFormatEditorEvents.WebEventArgumentAllColor

apply

Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.

29039

EnumGridFormatEvents.WebEventArgumentApplyGridFormatChanges

aStyle

Identifier for the argument that indicates the format style to use for all the borders of the target object. Usage:
This argument is used if GridFormatEditorBean.BORDER_LEVEL_ALL formatting is specified as the value of EnumGridFormatEditorEvents.WebEventArgumentBorderLevel. The list of possible values that can be shown is included and read from the WEB-INF/xml/BorderStyles.xml configuration file. The value to assign to this argument can be any of the values specified for the key attribute.

29029

EnumGridFormatEditorEvents.WebEventArgumentAllStyle

bColor

Identifier for the argument that indicates the color to use for the bottom border of the target object. Usage:
This argument is used if GridFormatEditorBean.BORDER_LEVEL_CUSTOM formatting is specified as the value of EnumGridFormatEditorEvents.WebEventArgumentBorderLevel. The list of possible values that can be used is included and read from the WEB-INF/xml/config/fillColorPicker.xml configuration file. The value to assign to this argument can be any valid color code (with the #RRGGBB format still, for its proper display on the options combo box, it is required that the value comes from of the XML file, specified by the key attributes.

29027

EnumGridFormatEditorEvents.WebEventArgumentBottomColor

bLevel

Identifier for the argument that indicates the level of border customization the user has selected to apply. Usage:
The user can specify formatting at different levels:
  • GridFormatEditorBean.BORDER_LEVEL_NONE - means no border will be displayed if the formatting is applied.
  • GridFormatEditorBean.BORDER_LEVEL_ALL - means the user can select one style and one color to apply to all the sides of the cells.
  • GridFormatEditorBean.BORDER_LEVEL_CUSTOM - means the user can select different colors and styles for each one of the sides of the cells.
  • GridFormatEditorBean.BORDER_LEVEL_DEFAULT - means no change will be done on the current formatting.
    		•

    29028

    EnumGridFormatEditorEvents.WebEventArgumentBorderLevel

    bStyle

    		Identifier for the argument that indicates the format style to use for the bottom border of the target object. Usage:
    This argument is used if GridFormatEditorBean.BORDER_LEVEL_CUSTOM formatting is specified as the value of EnumGridFormatEditorEvents.WebEventArgumentBorderLevel. The list of possible values that can be shown is included and read from the WEB-INF/xml/BorderStyles.xml configuration file. The value to assign to this argument can be any of the values specified for the key attribute.

    29026

    EnumGridFormatEditorEvents.WebEventArgumentBottomStyle

    close

    		Identifier for the argument that indicates the user has requested to close the editor without applying the changes.

    29041

    EnumGridFormatEditorEvents.WebEventArgumentCloseGridEditor

    hiColor

    		Identifier for the argument that indicates the horizontal inside border color to apply. Usage:
    This argument is not currently being applied on the grid.

    29017

    EnumGridFormatEditorEvents.WebEventArgumentHorizontalInsideColor

    hiStyle

    		Identifier for the argument that indicates the horizontal inside border style to apply. Usage:
    This argument is not currently being applied on the grid.

    29016

    EnumGridFormatEditorEvents.WebEventArgumentHorizontalInsideStyle

    lColor

    		Identifier for the argument that indicates the color to use for the left border of the target object. Usage:
    This argument is used if GridFormatEditorBean.BORDER_LEVEL_CUSTOM formatting is specified as the value of EnumGridFormatEditorEvents.WebEventArgumentBorderLevel. The list of possible values that can be used is included and read from the WEB-INF/xml/config/fillColorPicker.xml configuration file. The value to assign to this argument can be any valid color code (with the #RRGGBB format still, for its proper display on the options combo box, it is required that the value comes from of the XML file, specified by the key attributes.

    29023

    EnumGridFormatEditorEvents.WebEventArgumentLeftColor

    level

    		Identifier of the argument that indicates at which level the target object will be modified. Usage:
    Possible values for this argument include those defined on the EnumWebFormatType enumeration, such as EnumWebFormatType.WebFormatTypeHeader, EnumWebFormatType.WebFormatTypeGrid, etc.
    EnumWebFormatType.WebFormatTypeSubtotalGrid and EnumWebFormatType.WebFormatTypeSubtotalHeader do not apply when modifying metrics.

    29003

    EnumGridFormatEvents.WebEventArgumentLevel

    lStyle

    		Identifier for the argument that indicates the format style to use for the left border of the target object. Usage:
    This argument is used if GridFormatEditorBean.BORDER_LEVEL_CUSTOM formatting is specified as the value of EnumGridFormatEditorEvents.WebEventArgumentBorderLevel. The list of possible values that can be shown is included and read from the WEB-INF/xml/BorderStyles.xml configuration file. The value to assign to this argument can be any of the values specified for the key attribute.

    29022

    EnumGridFormatEditorEvents.WebEventArgumentLeftStyle

    ok

    		Identifier for the argument that indicates the user has requested to apply the changes and close the editor.

    29040

    EnumGridFormatEditorEvents.WebEventArgumentApplyAndCloseGridEditor

    oldStyle

    		Identifier for the argument that includes the name of the Old Style formatting used on the report. Usage:
    This argument is required if the report that is being formatted belongs to an older version. It is needed because otherwise the original formatting used for viewing the grid will be lost when a new format is applied to the report.

    29043

    EnumGridFormatEvents.WebEventArgumentOldStyle

    rColor

    		Identifier for the argument that indicates the color to use for the right border of the target object. Usage:
    This argument is used if GridFormatEditorBean.BORDER_LEVEL_CUSTOM formatting is specified as the value of EnumGridFormatEditorEvents.WebEventArgumentBorderLevel. The list of possible values that can be used is included and read from the WEB-INF/xml/config/fillColorPicker.xml configuration file. The value to assign to this argument can be any valid color code (with the #RRGGBB format still, for its proper display on the options combo box, it is required that the value comes from of the XML file, specified by the key attributes.

    29025

    EnumGridFormatEditorEvents.WebEventArgumentRightColor

    rStyle

    		Identifier for the argument that indicates the format style to use for the right border of the target object. Usage:
    This argument is used if GridFormatEditorBean.BORDER_LEVEL_CUSTOM formatting is specified as the value of EnumGridFormatEditorEvents.WebEventArgumentBorderLevel. The list of possible values that can be shown is included and read from the WEB-INF/xml/BorderStyles.xml configuration file. The value to assign to this argument can be any of the values specified for the key attribute.

    29024

    EnumGridFormatEditorEvents.WebEventArgumentRightStyle

    tColor

    		Identifier for the argument that indicates the color to use for the top border of the target object. Usage:
    This argument is used if GridFormatEditorBean.BORDER_LEVEL_CUSTOM formatting is specified as the value of EnumGridFormatEditorEvents.WebEventArgumentBorderLevel. The list of possible values that can be used is included and read from the WEB-INF/xml/config/fillColorPicker.xml configuration file. The value to assign to this argument can be any valid color code (with the #RRGGBB format still, for its proper display on the options combo box, it is required that the value comes from of the XML file, specified by the key attributes.

    29021

    EnumGridFormatEditorEvents.WebEventArgumentTopColor

    tStyle

    		Identifier for the argument that indicates the format style to use for the top border of the target object. Usage:
    This argument is used if GridFormatEditorBean.BORDER_LEVEL_CUSTOM formatting is specified as the value of EnumGridFormatEditorEvents.WebEventArgumentBorderLevel. The list of possible values that can be shown is included and read from the WEB-INF/xml/BorderStyles.xml configuration file. The value to assign to this argument can be any of the values specified for the key attribute.

    29020

    EnumGridFormatEditorEvents.WebEventArgumentTopStyle

    unit

    		Identifier for the argument that indicates the type of unit selected as target object. Usage:
    Possible values for this argument include those defined on the EnumGridFormatUnit enumeration, such as EnumGridFormatUnit.GridFormatColumns, EnumGridFormatUnit.GridFormatAllMetrics, etc.

    29031

    EnumGridFormatEvents.WebEventArgumentUnit

    viColor

    		Identifier for the argument that indicates the vertical inside border color to apply. Usage:
    This argument is not currently being applied on the grid.

    29019

    EnumGridFormatEditorEvents.WebEventArgumentVerticalInsideColor

    viStyle

    		Identifier for the argument that indicates the vertical inside border style to apply. Usage:
    This argument is not currently being applied on the grid.

    29018

    EnumGridFormatEditorEvents.WebEventArgumentVerticalInsideStyle
    processCellTab
    Identifier for the event that allows users to submit the indicated changes on the Align properties tab of the editor.

    29004

    EnumGridFormatEditorEvents.WebEventProcessCellTabProperties

    *axisPos

    		Identifier for the argument that includes the location of the target object to format. Usage:
    The possible values for this argument include strings that specify the axis and position location of the object to be formatted, separated by comma: axis,position.
    Valid values for the axis section of the value include those defined on the EnumDSSXMLAxisName enumeration, such as EnumDSSXMLAxisName.DssXmlAxisNameRows, so an argument value defined as 1,2 represents the second element on the rows axis.
    If the second element of the string (representing position) is zero, then the axis value indicates which full axis will be formatted, for example, 1,0 represents the row axis.
    If the second element of the string is a -1 the code represents a metric, and its position on the array of metrics is indicated on the first element of the value, for example 1,-1 represents the second metric on the grid.
    If the second element of the string has as value GridWebFormatHelper.LOCAL_TARGET_ALL_METRICS or GridWebFormatHelper.LOCAL_TARGET_ALL_REPORT then this indicates the formatting object that will be modified.

    29002

    EnumGridFormatEvents.WebEventArgumentAxisPosition

    apply

    		Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.

    29039

    EnumGridFormatEvents.WebEventArgumentApplyGridFormatChanges

    close

    		Identifier for the argument that indicates the user has requested to close the editor without applying the changes.

    29041

    EnumGridFormatEditorEvents.WebEventArgumentCloseGridEditor

    hAlign

    		Identifier for the argument that indicates the horizontal align to apply to the target object. Usage:
    The possible values for this argument come from the EnumGridHorizontalAlignmentType enumeration, including EnumGridHorizontalAlignmentType.GridHorizontalAlignmentDefault, EnumGridHorizontalAlignmentType.GridHorizontalAlignmentLeft, etc. Sending the EnumGridHorizontalAlignmentType.GridHorizontalAlignmentDefault value will indicate that no change should be performed on this property, on the default event handler.

    29013

    EnumGridFormatEditorEvents.WebEventArgumentHorizontalAlign

    level

    		Identifier of the argument that indicates at which level the target object will be modified. Usage:
    Possible values for this argument include those defined on the EnumWebFormatType enumeration, such as EnumWebFormatType.WebFormatTypeHeader, EnumWebFormatType.WebFormatTypeGrid, etc.
    EnumWebFormatType.WebFormatTypeSubtotalGrid and EnumWebFormatType.WebFormatTypeSubtotalHeader do not apply when modifying metrics.

    29003

    EnumGridFormatEvents.WebEventArgumentLevel

    ok

    		Identifier for the argument that indicates the user has requested to apply the changes and close the editor.

    29040

    EnumGridFormatEditorEvents.WebEventArgumentApplyAndCloseGridEditor

    oldStyle

    		Identifier for the argument that includes the name of the Old Style formatting used on the report. Usage:
    This argument is required if the report that is being formatted belongs to an older version. It is needed because otherwise the original formatting used for viewing the grid will be lost when a new format is applied to the report.

    29043

    EnumGridFormatEvents.WebEventArgumentOldStyle

    txtWrap

    		Identifier for the argument that indicates if text wrap should be applied on the cells or not. Usage:
    The possible values for this argument come from the EnumGridFormatGenericValues enumeration, including:
  • EnumGridFormatGenericValues.GridFormatGenericValuesDefault - indicating no change will be peformed for this property,
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseNo - indicating the user requests not to use text wrap, and
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseYes - indicating the user requests to use text wrap.
    		•

    29015

    EnumGridFormatEditorEvents.WebEventArgumentTextWrap

    unit

    		Identifier for the argument that indicates the type of unit selected as target object. Usage:
    Possible values for this argument include those defined on the EnumGridFormatUnit enumeration, such as EnumGridFormatUnit.GridFormatColumns, EnumGridFormatUnit.GridFormatAllMetrics, etc.

    29031

    EnumGridFormatEvents.WebEventArgumentUnit

    vAlign

    		Identifier for the argument that indicates the vertical align to apply to the target object. Usage:
    The possible values for this argument come from the EnumGridVerticalAlignmentType enumeration, including EnumGridVerticalAlignmentType.GridVerticalAlignmentDefault, EnumGridVerticalAlignmentType.GridVerticalAlignmentTop, etc. Sending the EnumGridVerticalAlignmentType.GridVerticalAlignmentDefault value will indicate that no change should be performed on this property, on the default event handler.

    29014

    EnumGridFormatEditorEvents.WebEventArgumentVerticalAlign
    processFontTab
    Identifier for the event that allows users to submit the indicated changes on the Font properties tab of the editor.

    29003

    EnumGridFormatEditorEvents.WebEventProcessFontTabProperties

    *axisPos

    		Identifier for the argument that includes the location of the target object to format. Usage:
    The possible values for this argument include strings that specify the axis and position location of the object to be formatted, separated by comma: axis,position.
    Valid values for the axis section of the value include those defined on the EnumDSSXMLAxisName enumeration, such as EnumDSSXMLAxisName.DssXmlAxisNameRows, so an argument value defined as 1,2 represents the second element on the rows axis.
    If the second element of the string (representing position) is zero, then the axis value indicates which full axis will be formatted, for example, 1,0 represents the row axis.
    If the second element of the string is a -1 the code represents a metric, and its position on the array of metrics is indicated on the first element of the value, for example 1,-1 represents the second metric on the grid.
    If the second element of the string has as value GridWebFormatHelper.LOCAL_TARGET_ALL_METRICS or GridWebFormatHelper.LOCAL_TARGET_ALL_REPORT then this indicates the formatting object that will be modified.

    29002

    EnumGridFormatEvents.WebEventArgumentAxisPosition

    apply

    		Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.

    29039

    EnumGridFormatEvents.WebEventArgumentApplyGridFormatChanges

    close

    		Identifier for the argument that indicates the user has requested to close the editor without applying the changes.

    29041

    EnumGridFormatEditorEvents.WebEventArgumentCloseGridEditor

    fBgColor

    		Identifier for the argument that indicates the background color to apply to the target object. Usage:
    The background color specified here will be used as part of the CSS definition of the final style to apply to the target object.

    29012

    EnumGridFormatEvents.WebEventArgumentFontBackgroundColor

    fBold

    		Identifier for the argument that indicates if font style bold is to be applied to the target object. Usage:
    The possible values of this argument include:
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseYes - indicates bold will be part of the style to use.
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseNo - indicates bold will not be applied to the target object.
  • EnumGridFormatGenericValues.GridFormatGenericValuesDefault - indicates no change will be done to the value currently defined for the property of the target object.
    		•

    29006

    EnumGridFormatEvents.WebEventArgumentFontBold

    fColor

    		Identifier for the argument that indicates the font color to apply to the target object. Usage:
    The font color specified here will be used as part of the CSS definition of the final style to apply to the target object.

    29010

    EnumGridFormatEvents.WebEventArgumentFontColor

    fItalic

    		Identifier for the argument that indicates if font style italic is to be applied to the target object. Usage:
    The possible values of this argument include:
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseYes - indicates italic will be part of the style to use.
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseNo - indicates italic will not be applied to the target object.
  • EnumGridFormatGenericValues.GridFormatGenericValuesDefault - indicates no change will be done to the value currently defined for the property of the target object.
    		•

    29007

    EnumGridFormatEvents.WebEventArgumentFontItalic

    fName

    		Identifier for the argument that indicates the font name to apply to the target object. Usage:
    The font name specified here will be used as part of the CSS definition of the final style to apply to the target object.

    29004

    EnumGridFormatEvents.WebEventArgumentFontName

    fScript

    		Identifier for the argument that indicates the font script to apply includes strikeout or not. Usage:
    This argument is not currently being applied on the grid.

    29011

    EnumGridFormatEditorEvents.WebEventArgumentFontScript

    fSize

    		Identifier for the argument that indicates the font size to apply to the target object. Usage:
    The font size specified here will be used as part of the CSS definition of the final style to apply to the target object.

    29005

    EnumGridFormatEvents.WebEventArgumentFontSize

    fStrikeout

    		Identifier for the argument that indicates the font style to apply includes strikeout or not. Usage:
    The possible values for this argument come from the EnumGridFormatGenericValues enumeration, including:
  • EnumGridFormatGenericValues.GridFormatGenericValuesDefault - indicating no change will be peformed for this property,
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseNo - indicating the user requests not to use this style, and
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseYes - indicating the user requests to use this style.
    		•

    29008

    EnumGridFormatEditorEvents.WebEventArgumentFontStrikeOut

    fUnderline

    		Identifier for the argument that indicates the font underline style to apply to the target object. Usage: The possible values of this argument include:
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseYes - indicates underline will be part of the style to use.
  • EnumGridFormatGenericValues.GridFormatGenericValuesUseNo - indicates underline will not be applied to the target object.
  • EnumGridFormatGenericValues.GridFormatGenericValuesDefault - indicates no change will be done to the value currently defined for the property of the target object.
    		•

    29009

    EnumGridFormatEvents.WebEventArgumentFontUnderline

    level

    		Identifier of the argument that indicates at which level the target object will be modified. Usage:
    Possible values for this argument include those defined on the EnumWebFormatType enumeration, such as EnumWebFormatType.WebFormatTypeHeader, EnumWebFormatType.WebFormatTypeGrid, etc.
    EnumWebFormatType.WebFormatTypeSubtotalGrid and EnumWebFormatType.WebFormatTypeSubtotalHeader do not apply when modifying metrics.

    29003

    EnumGridFormatEvents.WebEventArgumentLevel

    ok

    		Identifier for the argument that indicates the user has requested to apply the changes and close the editor.

    29040

    EnumGridFormatEditorEvents.WebEventArgumentApplyAndCloseGridEditor

    oldStyle

    		Identifier for the argument that includes the name of the Old Style formatting used on the report. Usage:
    This argument is required if the report that is being formatted belongs to an older version. It is needed because otherwise the original formatting used for viewing the grid will be lost when a new format is applied to the report.

    29043

    EnumGridFormatEvents.WebEventArgumentOldStyle

    unit

    		Identifier for the argument that indicates the type of unit selected as target object. Usage:
    Possible values for this argument include those defined on the EnumGridFormatUnit enumeration, such as EnumGridFormatUnit.GridFormatColumns, EnumGridFormatUnit.GridFormatAllMetrics, etc.

    29031

    EnumGridFormatEvents.WebEventArgumentUnit
    processNumberTab
    Identifier for the event that allows users to submit the indicated changes on the Number properties tab of the editor.

    29007

    EnumGridFormatEditorEvents.WebEventProcessNumberTabProperties

    *axisPos

    		Identifier for the argument that includes the location of the target object to format. Usage:
    The possible values for this argument include strings that specify the axis and position location of the object to be formatted, separated by comma: axis,position.
    Valid values for the axis section of the value include those defined on the EnumDSSXMLAxisName enumeration, such as EnumDSSXMLAxisName.DssXmlAxisNameRows, so an argument value defined as 1,2 represents the second element on the rows axis.
    If the second element of the string (representing position) is zero, then the axis value indicates which full axis will be formatted, for example, 1,0 represents the row axis.
    If the second element of the string is a -1 the code represents a metric, and its position on the array of metrics is indicated on the first element of the value, for example 1,-1 represents the second metric on the grid.
    If the second element of the string has as value GridWebFormatHelper.LOCAL_TARGET_ALL_METRICS or GridWebFormatHelper.LOCAL_TARGET_ALL_REPORT then this indicates the formatting object that will be modified.

    29002

    EnumGridFormatEvents.WebEventArgumentAxisPosition

    apply

    		Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.

    29039

    EnumGridFormatEvents.WebEventArgumentApplyGridFormatChanges

    close

    		Identifier for the argument that indicates the user has requested to close the editor without applying the changes.

    29041

    EnumGridFormatEditorEvents.WebEventArgumentCloseGridEditor

    currPos

    		Identifier for the argument that indicates the position where the currency symbol will be placed. Usage:
    This argument applies only when the category selected is EnumGridFormatNumberCategory.GridFormatNumberCategoryCurrency. The possible values that apply for this argument are defined on the EnumGridNumberCurrencyPosition enumeration and include EnumGridNumberCurrencyPosition.GRID_NUMBER_CURRENCY_POSITION_LEFT, EnumGridNumberCurrencyPosition.GRID_NUMBER_CURRENCY_POSITION_RIGHT, etc

    29036

    EnumGridFormatEditorEvents.WebEventArgumentNumberCurrencySymbolPosition

    currSymb

    		Identifier for the argument that specifies the symbol to be used for currency on the target object.

    29035

    EnumGridFormatEvents.WebEventArgumentNumberCurrencySymbol

    custom

    		Identifier for the argument that represents the custom formatting string the user has selected for the target object. Usage:
    This argument will hold a string with a custom formatting specification to be applied to the target object.

    29037

    EnumGridFormatEditorEvents.WebEventArgumentNumberCustom

    decPlaces

    		Identifier for the argument that indicates the number of decimal places to apply as part of the number formatting selected.

    29033

    EnumGridFormatEditorEvents.WebEventArgumentNumberDecimalPlaces

    level

    		Identifier of the argument that indicates at which level the target object will be modified. Usage:
    Possible values for this argument include those defined on the EnumWebFormatType enumeration, such as EnumWebFormatType.WebFormatTypeHeader, EnumWebFormatType.WebFormatTypeGrid, etc.
    EnumWebFormatType.WebFormatTypeSubtotalGrid and EnumWebFormatType.WebFormatTypeSubtotalHeader do not apply when modifying metrics.

    29003

    EnumGridFormatEvents.WebEventArgumentLevel

    negNum

    		Identifier for the argument that indicates the type of negative number formatting to apply as part of the number category selected. Usage:
    The negative number formatting options depends on the number category selected, and applies only for EnumGridFormatNumberCategory.GridFormatNumberCategoryFixed, EnumGridFormatNumberCategory.GridFormatNumberCategoryCurrency and EnumGridFormatNumberCategory.GridFormatNumberCategoryPercentage. The possible values that apply for this argument are defined on the EnumGridNegativeNumbersFormat enumeration and include EnumGridNegativeNumbersFormat.GridNegativeNumbersFormatRed, EnumGridNegativeNumbersFormat.GridNegativeNumbersFormatParenthesis, etc

    29034

    EnumGridFormatEditorEvents.WebEventArgumentNumberNegativeNumbers

    numCatPrefix

    		Identifier for the argument that indicates the prefix to use for identifying the number category selected. This argument is used for prefixing the different possible values of the number category format that can be selected by the user for the current target.
    Usage:
    To this prefix, the value of the number category to use will be appended. These values are defined on the EnumGridFormatNumberCategory enumeration, such as EnumGridFormatNumberCategory.GridFormatNumberCategoryGeneral, EnumGridFormatNumberCategory.GridFormatNumberCategoryCurrency, etc.

    29032

    EnumGridFormatEditorEvents.WebEventArgumentNumberCategoryPrefix

    ok

    		Identifier for the argument that indicates the user has requested to apply the changes and close the editor.

    29040

    EnumGridFormatEditorEvents.WebEventArgumentApplyAndCloseGridEditor

    oldStyle

    		Identifier for the argument that includes the name of the Old Style formatting used on the report. Usage:
    This argument is required if the report that is being formatted belongs to an older version. It is needed because otherwise the original formatting used for viewing the grid will be lost when a new format is applied to the report.

    29043

    EnumGridFormatEvents.WebEventArgumentOldStyle

    oNumCat

    		Identifier for the argument that indicates the number category to use on the selected target object. The difference between this argument and EnumGridFormatEditorEvents.WebEventArgumentNumberCategoryPrefix is that this argument represents the category selected by the user and the one to be applied if the user decides to do so; the prefix argument is only for allowing the user to switch from one category to the other, without actually changing the target object formatting at that time.
    Usage:
    The possible category values that can be assigned to this argument are defined on the EnumGridFormatNumberCategory enumeration, such as EnumGridFormatNumberCategory.GridFormatNumberCategoryGeneral, EnumGridFormatNumberCategory.GridFormatNumberCategoryCurrency, etc.

    29042

    EnumGridFormatEditorEvents.WebEventArgumentOriginalNumberCategory

    thSep

    		Identifier for the argument that specifies if Thousand Separator will be used on the target object. Usage:
    Possible values for this argument include 1 for indicating the thousand separator will be applied.

    29038

    EnumGridFormatEvents.WebEventArgumentThousandSeparator

    unit

    		Identifier for the argument that indicates the type of unit selected as target object. Usage:
    Possible values for this argument include those defined on the EnumGridFormatUnit enumeration, such as EnumGridFormatUnit.GridFormatColumns, EnumGridFormatUnit.GridFormatAllMetrics, etc.

    29031

    EnumGridFormatEvents.WebEventArgumentUnit
    setTopLeft
    Event for setting the top left position of the component

    73001

    EnumAppComponentEvents.WebEventSetTopLeftPosition

    *left

    		Event argument to define the left (x) position of the component

    73002

    EnumAppComponentEvents.WebEventArgumentLeftPosition

    *top

    		Event argument to define the top (y) position of the component

    73001

    EnumAppComponentEvents.WebEventArgumentTopPosition
    switchTab
    Identifier for the event that allows users to switch the tab currently displayed with the grid formatting information.

    29001

    EnumGridFormatEditorEvents.WebEventSwitchEditorTab

    *tab

    		Identifier for the argument that indicates the tab the user requested to be shown. Usage:
    Possible values for this argument include those listed on the EnumGridFormatEditorTabs enumeration, such as EnumGridFormatEditorTabs.GridFormatFontTab, EnumGridFormatEditorTabs.GridFormatBorderTab, etc.

    29001

    EnumGridFormatEditorEvents.WebEventArgumentTab

    Notes

    * denotes required field.