Mobile API Reference  MicroStrategy 2019
MsiFormat Namespace Reference

Classes

struct  _BandingPropertySet
 
class  BandingFormatting
 
class  BaseFormatManager
 
class  BaseFormatManagerHelper
 
class  BaseFormatting
 
class  CellLevelFormatting
 
class  CGAndConsolidationFormatting
 
class  ConsolidationFormatting
 
class  CustomGroupFormatting
 
struct  CustomGroupUnitInfo
 
class  DerivedElementFormatting
 
class  FormatInfo
 
struct  MetricUnitInfo
 
class  PropertyPackage
 
class  SubTotalFormatting
 
class  TemplateFormatting
 
class  ThresholdFormatting
 
struct  UnitInfo
 

Typedefs

typedef std::vector< CComVariant * > GridPropertyMap
 
typedef std::map< MBase::String, std::vector< MBase::String > > FontBuckets
 
typedef std::map< MBase::String, std::vector< std::string > > FontBuckets_N
 
typedef std::map< GUID, FormatInfo::Ptr > * FormatPoolPtr
 
typedef std::map< GUID, FormatInfo::PtrFormatPool
 
typedef struct MsiFormat::_BandingPropertySet BandingPropertySet
 
typedef std::pair< MBase::GUID, MBase::StringElementInfo
 

Enumerations

enum  GRID_AREA {
  GA_INVALID, GA_EXTRACOLUMN, GA_ROW, GA_COLUMN,
  GA_DATA, GA_DATA_NOMETRIC, GA_NON_DATA, GA_NO_OWNER_COL_VALUE,
  GA_NO_OWNER_ROW_VALUE, GA_EMPTY_ZONE
}
 
enum  EnumFormatRenderType { FRT_NORMAL = -1, FRT_GRAPH = 0, FRT_GRID = 1, FRT_OTHER = 2 }
 
enum  FORMAT_CATEGORY {
  FC_INVALID, FC_ATTR_TITLE, FC_ATTR_GRID, FC_SUBTOTAL_TITLE,
  FC_SUBTOTAL_GRID, FC_METRICS_TITLE, FC_METRIC_TITLE, FC_METRIC_GRID,
  FC_THRESHOLD, FC_HEADERS, FC_CORNER_ROW, FC_CORNER_COL,
  FC_CONSOLIDATION_ELEMENT_TITLE, FC_CONSOLIDATION_ELEMENT_GRID, FC_TEMPLATE_GRID
}
 
enum  FORMAT_LAYER_INDEX {
  FLI_RESERVED, FLI_TEMPLATE, FLI_BANDING, FLI_SUBTOTAL,
  FLI_CUSTOMGROUP, FLI_THRESHOLD, FLI_CONSOLIDATION, FLI_DERIVEDELEMENT,
  FLI_COMPOSITE_CG_CONSO, FLI_CELL
}
 
enum  FONTSTYLE { FONT_NORMAL = 0, FONT_BOLD = 1, FONT_ITALIC = 2, FONT_BOLDITALIC =3 }
 
enum  EXTRA_FMT_PROPERTIES {
  EXTR_BEGIN = -1, EXTR_SCALEDFACTOR = 0, EXTR_SCALEDNUMBERFORMAT = 1, EXTR_SCALEDNUMBERCATEGORY = 2,
  EXTR_END
}
 
enum  EXTRA_IDX_PROPERTIES { EXTR_IDX_SCALEDFACTOR = 0x01, EXTR_IDX_SCALEDNUMBERFORMAT = 0x02, EXTR_IDX_SCALEDNUMBERCATEGORY = 0x04 }
 
enum  BANDING_GROUP {
  BG_UNDEFINED = 16, BG_G1, BG_G2, BG_G1_HD,
  BG_G2_HD
}
 
enum  _GridProperty {
  _alignmentVertical, _alignmentTextDirection, _applyToGraphThreshold, _backgroundAlpha,
  _backgroundColor, _backgroundStyle, _highlightColor, _border3DStyle,
  _border3DWeight, _borderStyleBottom, _borderStyleLeft, _borderStyleRight,
  _borderStyleTop, _borderColorBottom, _borderColorLeft, _borderColorRight,
  _borderColorTop, _color, _currencySymbol, _currencyPosition,
  _decimalPlaces, _fontFamily, _fontSize, _fontWeight,
  _fontStyle, _fontScript, _fontStrikeout, _gradientAngle,
  _gradientColor, _gradientXOffset, _gradientYOffset, _hInsideColor,
  _hInsideStyle, _numberFormat, _negativeNumbers, _numberCategory,
  _paddingBottom, _paddingLeft, _paddingRight, _paddingTop,
  _patternColor, _patternStyle, _textAlign, _textDecoration,
  _thousandSeparator, _vInsideColor, _vInsideStyle, _wordWrap,
  _scaleFactor, _isDrillable, _inputControlStyle, _inputControlSetting,
  _gridEnd, _unDefined = _gridEnd, _heightMode, _columnScenario,
  _appearanceVisible, _addButtonBarPadding, _appearanceHideDuplicates, _appearanceName,
  _appearanceSpecialEffect, _appearanceTooltip, _appearanceTooltipText, _autoResizeInDesign,
  _applyGBToAllLayouts, _maxselectionNumber, _minselectionNumber, _autoSubmit,
  _searchOnServer, _noSelectionBehavior, _availableViewModes, _bandingEnabled,
  _bandingGroup1, _bandingGroup2, _bandingOptions, _bandingRowsColumns,
  _blackAndWhite, _bottomLeftCornerRadius, _bottomRightCornerRadius, _canDropLabelsCategory,
  _canDropLabelsLinear, _canGrow, _canGrowHorizontal, _canShrink,
  _canShrinkHorizontal, _canStagger, _colorGroup1, _colorGroup2,
  _defaultGridStyle, _defaultsVersion, _defaultViewMode, _dropShadowDepth,
  _dropShadowEffect, _editableViewMode, _embedFonts, _enableGridPadding,
  _expandToFit, _extraWidth, _fillStyle, _forceNewPage,
  _graphFormat, _graphQualityDPI, _gridAreaPercent, _gridPosition,
  _gridTextAlign, _gridWidth, _hasRoundedCorners, _headerWidth,
  _height, _htmlText, _htmlType, _hyperlink,
  _includeBookmarks, _indented, _isHyperlink, _keepGroupTogether,
  _keepSectionTogether, _left, _hideIfEmpty, _lineColor2,
  _lineSpacing, _lockAspectRatio, _isChildrenHorizontal, _isDataHorizontal,
  _lineColor, _lineOrientation, _lineStyle, _lineWeight,
  _imageSizeMode, _imageWidth, _imageHeight, _lockColumnHeaders,
  _lockRowHeaders, _longName, _marginBottom, _marginLeft,
  _marginRight, _marginTop, _maxHeight, _maxPieLabelRadius,
  _maxWidth, _mergeCells, _mergeColumnCells, _multiSliderAlignment,
  _name, _newRowOrColumn, _nestedLabel, _nestedLabelBracket,
  _oldHeight, _oldWidth, _openInNewWindow, _overflowMode,
  _orientationBehavior, _pageBreakBetweenGroups, _pageHeight, _pageOrientation,
  _pageScaling, _pageWidth, _paperType, _pictureAlignment,
  _pictureMode, _prefetch, _printFooterOn, _printHeaderOn,
  _repeatHorizontally, _repeatSection, _restartPageNumbering, _rowHeight,
  _rowScenario, _scalePageHeaderFooter, _scalePagesTall, _scalePagesWide,
  _scalePercentage, _secondaryDataProviders, _sectionCaption, _sectionExpanded,
  _sectionHorizontalOverflow, _selectorMouseOverAction, _selectorItemSpacing, _selectorItemWidthMode,
  _selectorMultiselect, _selectorOrientation, _selectorStyle, _selectorMetricConditionType,
  _showBookmarks, _showColHeaders, _showFloatingToolbars, _showGaugeLabel,
  _showInHTMLViewMode, _showRowHeaders, _showTitleBar, _showAsCollapsiblePanel,
  _showWidgetTitleBar, _singleSliderAlignment, _sliderFitToContents, _suppressLastLevel,
  _templateBanding, _templateShowColHeaders, _templateShowRowHeaders, _titleOverlapViewMode,
  _title, _titleBarDisplay, _tooltipText, _top,
  _topLeftCornerRadius, _topRightCornerRadius, _transitionDuration, _transitionID,
  _transitionUse, _url, _useGaugeDefaultSeriesColors, _useMasterPageHeaderFooter,
  _usePageWidthAsLayoutWidth, _viewTitle, _widgetClassName, _widgetEnable,
  _widgetIsApp, _widgetProperties, _widgetSWFPath, _width,
  _widthMode, _windowState, _zIndex, _enableHorizontalSwipeToChange,
  _executionFullScreenMode, _graphType, _longNames, _selectorSelectionColor,
  _supportedOrientations, _widgetProps, _widgetNameForIPad, _maxCategories,
  _maxSeries, _legendDisplay, _titleDisplay, _depthEffect,
  _displayPageByBar, _displaySelectorDocked, _useAsInformationWindow, _informationWindowPlacement,
  _infoWindowMode, _infoWindowPosition, _tabCloseToDismissInfoWindow, _displayInPartialScreen,
  _initialSlidingInWidth, _initialSlidingInHeight, _themeColorType, _informationWindowTarget,
  _ctlAutoSubmit, _showControlTitleBar, _textOverflow, _selectorInclude,
  _visProps, _widgetNameForIPhone, _enableGraphTooltips, _enableZoom,
  _layoutBarPosition, _layoutBarStyle, _fitPDFContentHeight, _analysisSection,
  _filterDisplay, _displayText, _displayConfirmation, _offlineSubmission,
  _txnSubmitInOrder, _displayRepromptIcon, _useLayoutAsInformationWindow, _useAsFilterPanel,
  _useAsMasterPanel, _useAsFilterSummaryPanel, _layoutXML, _useSegments,
  _styleForSwitchingPanel, _resetToFirstPanelWhenTargeted, _copyMode, _enableCopyForText,
  _isNavigationDocument, _showingBarsTemporarily, _propertyEnd, _backGroundAlpha = _backgroundAlpha,
  _backGroundColor = _backgroundColor, _fontFamily2 = _fontFamily, _backGroundStyle = _backgroundStyle, _transparency,
  _blur
}
 
enum  CUSTOM_GROUP_LEVEL { CUSTGRP_UNDEFINED = -1, CUSTGRP_ELEMENT = 5, CUSTGRP_BANDING = 7, CUSTGRP_INDIVIDUAL_ITEM = 11 }
 

Functions

BaseFormatManager::Ptr CreateBaseFormatManager (DSSRWGridIterator *ipIterator)
 

Variables

const FORMAT_LAYER_INDEX gFormattingLayerIndex []
 
const Int32 gKeyBandingIndexOffset = 3
 
const Int32 gKeySubtotalIndexOffset = 2
 
const Int32 gKeySpecialSection = 3
 

Typedef Documentation

◆ BandingPropertySet

◆ ElementInfo

◆ FontBuckets

typedef std::map<MBase::String, std::vector<MBase::String> > MsiFormat::FontBuckets

◆ FontBuckets_N

typedef std::map<MBase::String, std::vector<std::string> > MsiFormat::FontBuckets_N

◆ FormatPool

◆ FormatPoolPtr

◆ GridPropertyMap

typedef std::vector<CComVariant*> MsiFormat::GridPropertyMap

Enumeration Type Documentation

◆ _GridProperty

Enumerator
_alignmentVertical 
_alignmentTextDirection 
_applyToGraphThreshold 
_backgroundAlpha 
_backgroundColor 
_backgroundStyle 
_highlightColor 
_border3DStyle 
_border3DWeight 
_borderStyleBottom 
_borderStyleLeft 
_borderStyleRight 
_borderStyleTop 
_borderColorBottom 
_borderColorLeft 
_borderColorRight 
_borderColorTop 
_color 
_currencySymbol 
_currencyPosition 
_decimalPlaces 
_fontFamily 
_fontSize 
_fontWeight 
_fontStyle 
_fontScript 
_fontStrikeout 
_gradientAngle 
_gradientColor 
_gradientXOffset 
_gradientYOffset 
_hInsideColor 
_hInsideStyle 
_numberFormat 
_negativeNumbers 
_numberCategory 
_paddingBottom 
_paddingLeft 
_paddingRight 
_paddingTop 
_patternColor 
_patternStyle 
_textAlign 
_textDecoration 
_thousandSeparator 
_vInsideColor 
_vInsideStyle 
_wordWrap 
_scaleFactor 
_isDrillable 
_inputControlStyle 
_inputControlSetting 
_gridEnd 
_unDefined 
_heightMode 
_columnScenario 
_appearanceVisible 
_addButtonBarPadding 
_appearanceHideDuplicates 
_appearanceName 
_appearanceSpecialEffect 
_appearanceTooltip 
_appearanceTooltipText 
_autoResizeInDesign 
_applyGBToAllLayouts 
_maxselectionNumber 
_minselectionNumber 
_autoSubmit 
_searchOnServer 
_noSelectionBehavior 
_availableViewModes 
_bandingEnabled 
_bandingGroup1 
_bandingGroup2 
_bandingOptions 
_bandingRowsColumns 
_blackAndWhite 
_bottomLeftCornerRadius 
_bottomRightCornerRadius 
_canDropLabelsCategory 
_canDropLabelsLinear 
_canGrow 
_canGrowHorizontal 
_canShrink 
_canShrinkHorizontal 
_canStagger 
_colorGroup1 
_colorGroup2 
_defaultGridStyle 
_defaultsVersion 
_defaultViewMode 
_dropShadowDepth 
_dropShadowEffect 
_editableViewMode 
_embedFonts 
_enableGridPadding 
_expandToFit 
_extraWidth 
_fillStyle 
_forceNewPage 
_graphFormat 
_graphQualityDPI 
_gridAreaPercent 
_gridPosition 
_gridTextAlign 
_gridWidth 
_hasRoundedCorners 
_headerWidth 
_height 
_htmlText 
_htmlType 
_hyperlink 
_includeBookmarks 
_indented 
_isHyperlink 
_keepGroupTogether 
_keepSectionTogether 
_left 
_hideIfEmpty 
_lineColor2 
_lineSpacing 
_lockAspectRatio 
_isChildrenHorizontal 
_isDataHorizontal 
_lineColor 
_lineOrientation 
_lineStyle 
_lineWeight 
_imageSizeMode 
_imageWidth 
_imageHeight 
_lockColumnHeaders 
_lockRowHeaders 
_longName 
_marginBottom 
_marginLeft 
_marginRight 
_marginTop 
_maxHeight 
_maxPieLabelRadius 
_maxWidth 
_mergeCells 
_mergeColumnCells 
_multiSliderAlignment 
_name 
_newRowOrColumn 
_nestedLabel 
_nestedLabelBracket 
_oldHeight 
_oldWidth 
_openInNewWindow 
_overflowMode 
_orientationBehavior 
_pageBreakBetweenGroups 
_pageHeight 
_pageOrientation 
_pageScaling 
_pageWidth 
_paperType 
_pictureAlignment 
_pictureMode 
_prefetch 
_printFooterOn 
_printHeaderOn 
_repeatHorizontally 
_repeatSection 
_restartPageNumbering 
_rowHeight 
_rowScenario 
_scalePageHeaderFooter 
_scalePagesTall 
_scalePagesWide 
_scalePercentage 
_secondaryDataProviders 
_sectionCaption 
_sectionExpanded 
_sectionHorizontalOverflow 
_selectorMouseOverAction 
_selectorItemSpacing 
_selectorItemWidthMode 
_selectorMultiselect 
_selectorOrientation 
_selectorStyle 
_selectorMetricConditionType 
_showBookmarks 
_showColHeaders 
_showFloatingToolbars 
_showGaugeLabel 
_showInHTMLViewMode 
_showRowHeaders 
_showTitleBar 
_showAsCollapsiblePanel 
_showWidgetTitleBar 
_singleSliderAlignment 
_sliderFitToContents 
_suppressLastLevel 
_templateBanding 
_templateShowColHeaders 
_templateShowRowHeaders 
_titleOverlapViewMode 
_title 
_titleBarDisplay 
_tooltipText 
_top 
_topLeftCornerRadius 
_topRightCornerRadius 
_transitionDuration 
_transitionID 
_transitionUse 
_url 
_useGaugeDefaultSeriesColors 
_useMasterPageHeaderFooter 
_usePageWidthAsLayoutWidth 
_viewTitle 
_widgetClassName 
_widgetEnable 
_widgetIsApp 
_widgetProperties 
_widgetSWFPath 
_width 
_widthMode 
_windowState 
_zIndex 
_enableHorizontalSwipeToChange 
_executionFullScreenMode 
_graphType 
_longNames 
_selectorSelectionColor 
_supportedOrientations 
_widgetProps 
_widgetNameForIPad 
_maxCategories 
_maxSeries 
_legendDisplay 
_titleDisplay 
_depthEffect 
_displayPageByBar 
_displaySelectorDocked 
_useAsInformationWindow 
_informationWindowPlacement 
_infoWindowMode 
_infoWindowPosition 
_tabCloseToDismissInfoWindow 
_displayInPartialScreen 
_initialSlidingInWidth 
_initialSlidingInHeight 
_themeColorType 
_informationWindowTarget 
_ctlAutoSubmit 
_showControlTitleBar 
_textOverflow 
_selectorInclude 
_visProps 
_widgetNameForIPhone 
_enableGraphTooltips 
_enableZoom 
_layoutBarPosition 
_layoutBarStyle 
_fitPDFContentHeight 
_analysisSection 
_filterDisplay 
_displayText 
_displayConfirmation 
_offlineSubmission 
_txnSubmitInOrder 
_displayRepromptIcon 
_useLayoutAsInformationWindow 
_useAsFilterPanel 
_useAsMasterPanel 
_useAsFilterSummaryPanel 
_layoutXML 
_useSegments 
_styleForSwitchingPanel 
_resetToFirstPanelWhenTargeted 
_copyMode 
_enableCopyForText 
_isNavigationDocument 
_showingBarsTemporarily 
_propertyEnd 
_backGroundAlpha 
_backGroundColor 
_fontFamily2 
_backGroundStyle 
_transparency 
_blur 

◆ BANDING_GROUP

Enumerator
BG_UNDEFINED 
BG_G1 
BG_G2 
BG_G1_HD 
BG_G2_HD 

◆ CUSTOM_GROUP_LEVEL

Enumerator
CUSTGRP_UNDEFINED 
CUSTGRP_ELEMENT 
CUSTGRP_BANDING 
CUSTGRP_INDIVIDUAL_ITEM 

◆ EnumFormatRenderType

Enumerator
FRT_NORMAL 
FRT_GRAPH 
FRT_GRID 
FRT_OTHER 

◆ EXTRA_FMT_PROPERTIES

Enumerator
EXTR_BEGIN 
EXTR_SCALEDFACTOR 
EXTR_SCALEDNUMBERFORMAT 
EXTR_SCALEDNUMBERCATEGORY 
EXTR_END 

◆ EXTRA_IDX_PROPERTIES

Enumerator
EXTR_IDX_SCALEDFACTOR 
EXTR_IDX_SCALEDNUMBERFORMAT 
EXTR_IDX_SCALEDNUMBERCATEGORY 

◆ FONTSTYLE

Enumerator
FONT_NORMAL 
FONT_BOLD 
FONT_ITALIC 
FONT_BOLDITALIC 

◆ FORMAT_CATEGORY

Enumerator
FC_INVALID 
FC_ATTR_TITLE 
FC_ATTR_GRID 
FC_SUBTOTAL_TITLE 
FC_SUBTOTAL_GRID 
FC_METRICS_TITLE 
FC_METRIC_TITLE 
FC_METRIC_GRID 
FC_THRESHOLD 
FC_HEADERS 
FC_CORNER_ROW 
FC_CORNER_COL 
FC_CONSOLIDATION_ELEMENT_TITLE 
FC_CONSOLIDATION_ELEMENT_GRID 
FC_TEMPLATE_GRID 

◆ FORMAT_LAYER_INDEX

Enumerator
FLI_RESERVED 
FLI_TEMPLATE 
FLI_BANDING 
FLI_SUBTOTAL 
FLI_CUSTOMGROUP 
FLI_THRESHOLD 
FLI_CONSOLIDATION 
FLI_DERIVEDELEMENT 
FLI_COMPOSITE_CG_CONSO 
FLI_CELL 

◆ GRID_AREA

Enumerator
GA_INVALID 
GA_EXTRACOLUMN 
GA_ROW 
GA_COLUMN 
GA_DATA 
GA_DATA_NOMETRIC 
GA_NON_DATA 
GA_NO_OWNER_COL_VALUE 
GA_NO_OWNER_ROW_VALUE 
GA_EMPTY_ZONE 

Function Documentation

◆ CreateBaseFormatManager()

BaseFormatManager::Ptr MsiFormat::CreateBaseFormatManager ( DSSRWGridIterator ipIterator)

Variable Documentation

◆ gFormattingLayerIndex

const FORMAT_LAYER_INDEX MsiFormat::gFormattingLayerIndex[]
Initial value:
Definition: BaseFormatManagerHelper.h:39
Definition: BaseFormatManagerHelper.h:33
Definition: BaseFormatManagerHelper.h:35
Definition: BaseFormatManagerHelper.h:34
Definition: BaseFormatManagerHelper.h:41
Definition: BaseFormatManagerHelper.h:40
Definition: BaseFormatManagerHelper.h:37

◆ gKeyBandingIndexOffset

const Int32 MsiFormat::gKeyBandingIndexOffset = 3

◆ gKeySpecialSection

const Int32 MsiFormat::gKeySpecialSection = 3

◆ gKeySubtotalIndexOffset

const Int32 MsiFormat::gKeySubtotalIndexOffset = 2