Package com.microstrategy.web.app.beans

Interface EnumGridFormatEvents

All Superinterfaces:

EnumFrameEditorEvents, EnumPageEvents, EnumServletEvents

All Known Subinterfaces:

EnumGridFormatEditorEvents, EnumGridFormatToolbarEvents

public interface EnumGridFormatEvents
extends EnumFrameEditorEvents

This enumeration contains the list of events and arguments handled by the Grid Format beans, such as the GridFormatEditorBean and the GridFormatToolbarBean

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static int	WebEventArgumentApplyGridFormatChanges	Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.
static int	WebEventArgumentAxisPosition	Identifier for the argument that includes the location of the target object to format.
static int	WebEventArgumentFontBackgroundColor	Identifier for the argument that indicates the background color to apply to the target object.
static int	WebEventArgumentFontBold	Identifier for the argument that indicates if font style bold is to be applied to the target object.
static int	WebEventArgumentFontColor	Identifier for the argument that indicates the font color to apply to the target object.
static int	WebEventArgumentFontItalic	Identifier for the argument that indicates if font style italic is to be applied to the target object.
static int	WebEventArgumentFontName	Identifier for the argument that indicates the font name to apply to the target object.
static int	WebEventArgumentFontSize	Identifier for the argument that indicates the font size to apply to the target object.
static int	WebEventArgumentFontUnderline	Identifier for the argument that indicates the font underline style to apply to the target object.
static int	WebEventArgumentLevel	Identifier of the argument that indicates at which level the target object will be modified.
static int	WebEventArgumentNumberCurrencySymbol	Identifier for the argument that specifies the symbol to be used for currency on the target object.
static int	WebEventArgumentOldStyle	Identifier for the argument that includes the name of the Old Style formatting used on the report.
static int	WebEventArgumentThousandSeparator	Identifier for the argument that specifies if Thousand Separator will be used on the target object.
static int	WebEventArgumentUnit	Identifier for the argument that indicates the type of unit selected as target object.

Fields inherited from interface com.microstrategy.web.app.beans.EnumFrameEditorEvents

WebEventApply, WebEventCancel, WebEventClose, WebEventOk, WebEventOpen

Fields inherited from interface com.microstrategy.web.app.beans.EnumPageEvents

WebEventArgumentAddUnitButton, WebEventArgumentAnswerFormat, WebEventArgumentAnswerOptions, WebEventArgumentAttributeIdFormId, WebEventArgumentBean, WebEventArgumentBoneHeight, WebEventArgumentBoneName, WebEventArgumentBoneWidth, WebEventArgumentBrowserSettingName, WebEventArgumentBrowserSettingValue, WebEventArgumentClearExistinAndAddUnitsButton, WebEventArgumentExecutePromptedReport, WebEventArgumentFolderViewMode, WebEventArgumentLoadFile, WebEventArgumentLoadFileSeparator, WebEventArgumentNCSubscriptionsViewMode, WebEventArgumentPrefName, WebEventArgumentPrefValue, WebEventArgumentPromptFunction, WebEventArgumentRefreshOrigin, WebEventArgumentSaveFolderID, WebEventArgumentScreenMode, WebEventArgumentSecurityRolesViewMode, WebEventArgumentShowBean, WebEventArgumentShowBeanProperties, WebEventArgumentSubscriptionsViewMode, WebEventArgumentTextFileAnswer, WebEventArgumentUnitsToAdd, WebEventArgumentUserManagerViewModeType, WebEventChangeFolderViewMode, WebEventChangeSecurityRolesViewMode, WebEventChangeSubscriptionsViewMode, WebEventChangeUserManagerViewModeType, WebEventRefresh, WebEventSetPermanentBrowserSetting, WebEventSetSaveFolderID, WebEventSetSessionBrowserSetting, WebEventShowBean, WebEventSwitchScreenMode, WebEventUpdateBoneProperty, WebEventUpdatePreference

Fields inherited from interface com.microstrategy.web.app.beans.EnumServletEvents

RWebEventArgumentIMPORTAFTERSAVE, WebEventAddCacheSubscription, WebEventAddInboxSubscription, WebEventAddMobileSubscription, WebEventAddPersonalViewSubscription, WebEventAddSubscription, WebEventAdminOpenHome, WebEventArgumentActionType, WebEventArgumentAdvancedOption, WebEventArgumentAllowExecute, WebEventArgumentAnalysisAddMode, WebEventArgumentAnalysisID, WebEventArgumentApplyChangesFirst, WebEventArgumentAuthenticationMode, WebEventArgumentBeansState, WebEventArgumentCheckLogin, WebEventArgumentClearPage, WebEventArgumentConvertDashboardToDoc, WebEventArgumentCubeName, WebEventArgumentCubeReportId, WebEventArgumentDocumentID, WebEventArgumentDocumentViewMode, WebEventArgumentDrillDisplayMode, WebEventArgumentDrillElementList, WebEventArgumentDrillFilterOnPageBy, WebEventArgumentDrillGraphPixelX, WebEventArgumentDrillGraphPixelY, WebEventArgumentDrillPathKey, WebEventArgumentDrillRetainParent, WebEventArgumentDrillRetainThreshold, WebEventArgumentEventToForwardTo, WebEventArgumentExportDefaultRunMode, WebEventArgumentExportExpandPageByFields, WebEventArgumentexportFilterDetails, WebEventArgumentExportFormatNameGraphs, WebEventArgumentExportFormatNameGrids, WebEventArgumentExportFromOptions, WebEventArgumentExportHeadersAsText, WebEventArgumentExportMetricValuesAsText, WebEventArgumentExportOfficeRefresh, WebEventArgumentExportOverlapGridTitles, WebEventArgumentExportSection, WebEventArgumentExportTextDelimiter, WebEventArgumentExportUseLiveChartGraphs, WebEventArgumentExportUseSeparateSheets, WebEventArgumentFacebookToken, WebEventArgumentFastExportLink, WebEventArgumentFolderId, WebEventArgumentFolderName, WebEventArgumentFolderType, WebEventArgumentFromPageHistory, WebEventArgumentGraphHeight, WebEventArgumentGraphRequestId, WebEventArgumentGraphShrinkHeight, WebEventArgumentGraphShrinkWidth, WebEventArgumentGraphWidth, WebEventArgumentIgnoreGraphHeightWidth, WebEventArgumentIsAdminHelp, WebEventArgumentIsContinueForm, WebEventArgumentIsCubeEdit, WebEventArgumentIsCubeRepublish, WebEventArgumentIsFFSQL, WebEventArgumentIsFromPrompt, WebEventArgumentIsNew, WebEventArgumentIsNewAnalysis, WebEventArgumentLoginMode, WebEventArgumentMenuID, WebEventArgumentMenuOptionID, WebEventArgumentMessage, WebEventArgumentMessageID, WebEventArgumentNodeKey, WebEventArgumentNotAskExportOptions, WebEventArgumentObjectID, WebEventArgumentObjectType, WebEventArgumentParentFolderId, WebEventArgumentPDFAdminFooterFile, WebEventArgumentPDFAdminHeaderFile, WebEventArgumentPDFCoverPageFilterDetails, WebEventArgumentPDFExpandPageByFields, WebEventArgumentPDFExportFilename, WebEventArgumentPDFExportSection, WebEventArgumentPDFFitToPagesTall, WebEventArgumentPDFFitToPagesWide, WebEventArgumentPDFFooterCenterSection, WebEventArgumentPDFFooterLeftSection, WebEventArgumentPDFFooterRightSection, WebEventArgumentPDFHeaderCenterSection, WebEventArgumentPDFHeaderLeftSection, WebEventArgumentPDFHeaderRightSection, WebEventArgumentPDFMarginSizeBottom, WebEventArgumentPDFMarginSizeLeft, WebEventArgumentPDFMarginSizeRight, WebEventArgumentPDFMarginSizeTop, WebEventArgumentPDFMaxCells, WebEventArgumentPDFMaxFooterSize, WebEventArgumentPDFMaxHeaderSize, WebEventArgumentPDFOutlineModeState, WebEventArgumentPDFPaperOrientationOption, WebEventArgumentPDFPaperSize, WebEventArgumentPDFScalingOption, WebEventArgumentPDFShowOptions, WebEventArgumentPDFShrinkFontPercentage, WebEventArgumentPortNumber, WebEventArgumentPreferenceGroup, WebEventArgumentPreferenceGroupSet, WebEventArgumentPreferenceTransform, WebEventArgumentPrintAdminFooterFile, WebEventArgumentPrintAdminHeaderFile, WebEventArgumentPrintCoverPageFilterDetails, WebEventArgumentPrintDefaultColsPerPage, WebEventArgumentPrintDefaultRowsPerPage, WebEventArgumentPrintDisplayPopupPrintDialog, WebEventArgumentPrintExpandPagebyFields, WebEventArgumentPrintFitColsToPage, WebEventArgumentPrintFitRowsToPage, WebEventArgumentPrintFooterCenterSection, WebEventArgumentPrintFooterLeftSection, WebEventArgumentPrintFooterRightSection, WebEventArgumentPrintGridColsPerPage, WebEventArgumentPrintGridGraphSamePage, WebEventArgumentPrintGridRowsPerPage, WebEventArgumentPrintHeaderCenterSection, WebEventArgumentPrintHeaderLeftSection, WebEventArgumentPrintHeaderRightSection, WebEventArgumentPrintMarginSizeBottom, WebEventArgumentPrintMarginSizeLeft, WebEventArgumentPrintMarginSizeRight, WebEventArgumentPrintMarginSizeTop, WebEventArgumentPrintMaxCellsPerBlock, WebEventArgumentPrintMaxColsPerPage, WebEventArgumentPrintMaxFooterSize, WebEventArgumentPrintMaxGraphsPerBlock, WebEventArgumentPrintMaxHeaderSize, WebEventArgumentPrintMaxRowsPerPage, WebEventArgumentPrintOpenNewWindow, WebEventArgumentPrintPaperOrientationOption, WebEventArgumentPrintPaperSize, WebEventArgumentPrintScalingOption, WebEventArgumentPrintShowOptionsOnPrint, WebEventArgumentPrintShrinkFontPercentage, WebEventArgumentProjectName, WebEventArgumentPromptExpressionType, WebEventArgumentPromptStyle, WebEventArgumentQueryBuild, WebEventArgumentRelativePageNumber, WebEventArgumentReportDesignMode, WebEventArgumentReportFilterID, WebEventArgumentReportParentFolderID, WebEventArgumentReportStateID, WebEventArgumentReportTemplateID, WebEventArgumentReportViewMode, WebEventArgumentRWCreationFlags, WebEventArgumentRWCreationTemplateID, WebEventArgumentRWExecutionMode, WebEventArgumentRWExportMode, WebEventArgumentRWPageByElements, WebEventArgumentRWViewMode, WebEventArgumentSaveAsOrigin, WebEventArgumentSaveAsOriginPath, WebEventArgumentSaveAsShowContinueButton, WebEventArgumentScheduleEditMode, WebEventArgumentSearchDomain, WebEventArgumentSearchString, WebEventArgumentServerAlias, WebEventArgumentServerName, WebEventArgumentSessionKey, WebEventArgumentShow, WebEventArgumentShowDefault, WebEventArgumentShowOptionsPage, WebEventArgumentShowServerProperties, WebEventArgumentSliceId, WebEventArgumentSourceId, WebEventArgumentSourceType, WebEventArgumentSubPage, WebEventArgumentSubscriptionDeliveryMode, WebEventArgumentSubscriptionID, WebEventArgumentTarget, WebEventArgumentTreeType, WebEventArgumentTriggerID, WebEventArgumentTwoStepVerificationCode, WebEventArgumentUpdateParentWindow, WebEventArgumentUserId, WebEventArgumentUserName, WebEventArgumentUserPassword, WebEventCallChangePassword, WebEventCloseDashboardPage, WebEventCreateBlankVI, WebEventCreateHTML5VI, WebEventCreateOptimizedVI, WebEventCreatePrompt, WebEventCreateSecurityRole, WebEventCreateUser, WebEventCreateUserGroup, WebEventDashboardPublishWizard, WebEventDeleteHistoryList, WebEventDeleteObject, WebEventDisplayError, WebEventDrillToFixedTemplateFromDocToReport, WebEventEditCacheSubscription, WebEventEditInboxSubscription, WebEventEditMobileSubscription, WebEventEditPersonalViewSubscription, WebEventEditPrompt, WebEventEditReport, WebEventEditRW, WebEventEditSecurityRole, WebEventEditSubscription, WebEventEditUser, WebEventEditUserGroup, WebEventExecuteHTML5VI, WebEventExecuteMojoIVE, WebEventExecuteRWDocumentHeavy, WebEventExportSaveReportProperties, WebEventFastDocumentExport, WebEventFastExport, WebEventFastPDFExport, WebEventForwardToRWExport, WebEventGeneric, WebEventGetDocumentDetails, WebEventGetReportDetails, WebEventGetRWDocumentDetails, WebEventGraphDrillFromDocToReport, WebEventGridDrillFromDocToReport, WebEventHTMLMenu, WebEventInitializeHTML5VIFromSubscription, WebEventIPadAnnotation, WebEventLoadGraph, WebEventLogout, WebEventNCAddFileSubscription, WebEventNCAddFTPSubscription, WebEventNCAddPrintSubscription, WebEventNCAddresses, WebEventNCAddSubscription, WebEventNCEditFileSubscription, WebEventNCEditFTPSubscription, WebEventNCEditPrintSubscription, WebEventNCEditSubscription, WebEventNCFileAddresses, WebEventNCFTPAddresses, WebEventNCOpenDeleteAddress, WebEventNCPrintAddresses, WebEventNCSendNow, WebEventNCSendNowConfirm, WebEventNCSubsConfirm, WebEventOpenAbout, WebEventOpenAdminFAQs, WebEventOpenAdminHelp, WebEventOpenAdminHelpIndex, WebEventOpenCreate, WebEventOpenCreateDocument, WebEventOpenCreatePromptPage, WebEventOpenDefaultDesktop, WebEventOpenDefaultHomePage, WebEventOpenDesktop, WebEventOpenDiagnostics, WebEventOpenExport, WebEventOpenExportDocument, WebEventOpenExportOptions, WebEventOpenExportOptionsFromReport, WebEventOpenFAQs, WebEventOpenFilterEditor, WebEventOpenHelp, WebEventOpenHelpIndex, WebEventOpenHelpSetup, WebEventOpenHistoryList, WebEventOpenHistoryPage, WebEventOpenHome, WebEventOpenImportWizard, WebEventOpenImportWizardEntryPage, WebEventOpenIPAConfiguration, WebEventOpenIPAMonitor, WebEventOpenMyPage, WebEventOpenMyReports, WebEventOpenMySubscriptions, WebEventOpenObjectSubscriptions, WebEventOpenOfficeSetup, WebEventOpenOptimizedVI, WebEventOpenPage, WebEventOpenPDFOptions, WebEventOpenPDFOptionsFromReport, WebEventOpenPDFSaveReportProperties, WebEventOpenPreferences, WebEventOpenPrint, WebEventOpenPrintDocument, WebEventOpenPrintOptions, WebEventOpenPrintOptionsFromReport, WebEventOpenPrintSaveReportProperties, WebEventOpenQBuilder, WebEventOpenRRAccountSetting, WebEventOpenRRQuoteAcceptanceForm, WebEventopenRRUserImport, WebEventOpenRRUserManagement, WebEventOpenSaveReportProperties, WebEventOpenSchedule, WebEventOpenSearch, WebEventOpenSecurityRolesFolder, WebEventOpenSecuritySetup, WebEventOpenSharedReports, WebEventOpenSubscriptionEngineSetup, WebEventOpenSummary, WebEventOpenTopLevelUserGroups, WebEventOpenWizard, WebEventPDFDisplay, WebEventPrefColorPalette, WebEventPrefDynamicAddresseList, WebEventProcessLogin, WebEventQuickLogout, WebEventReportFlashExport, WebEventReportWritingDocumentPDFExport, WebEventReportWritingDocumentPDFFastExport, WebEventReturnTo, WebEventRunSearch, WebEventRWDHTMLExport, WebEventRWExport, WebEventRWSaveAs, WebEventSaveAs, WebEventSelectFilter, WebEventSelectTemplate, WebEventTakeMeHome, WebOpenAnalysis, WebOpenPrefChangePwdPage

Field Detail

WebEventArgumentAxisPosition

static final int WebEventArgumentAxisPosition

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.

See Also:

Constant Field Values

WebEventArgumentLevel

static final int WebEventArgumentLevel

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.

See Also:

Constant Field Values

WebEventArgumentUnit

static final int WebEventArgumentUnit

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.

See Also:

Constant Field Values

WebEventArgumentFontName

static final int WebEventArgumentFontName

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.

See Also:

Constant Field Values

WebEventArgumentFontSize

static final int WebEventArgumentFontSize

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.

See Also:

Constant Field Values

WebEventArgumentFontBold

static final int WebEventArgumentFontBold

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.

See Also:

Constant Field Values

WebEventArgumentFontItalic

static final int WebEventArgumentFontItalic

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.

See Also:

Constant Field Values

WebEventArgumentFontUnderline

static final int WebEventArgumentFontUnderline

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.

See Also:

Constant Field Values

WebEventArgumentFontColor

static final int WebEventArgumentFontColor

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.

See Also:

Constant Field Values

WebEventArgumentFontBackgroundColor

static final int WebEventArgumentFontBackgroundColor

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.

See Also:

Constant Field Values

WebEventArgumentNumberCurrencySymbol

static final int WebEventArgumentNumberCurrencySymbol

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

See Also:

Constant Field Values

WebEventArgumentThousandSeparator

static final int WebEventArgumentThousandSeparator

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.

See Also:

Constant Field Values

WebEventArgumentApplyGridFormatChanges

static final int WebEventArgumentApplyGridFormatChanges

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

See Also:

Constant Field Values

WebEventArgumentOldStyle

static final int WebEventArgumentOldStyle

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.

See Also:

Constant Field Values