IDSSGridFormatter Interface Reference

Detailed Description

The IDSSGridFormatter interface provides the format information, value, and formatted string for every header, title, and cell of the grid.

It keeps a collection of format objects used by anything in this grid, and returns the index into the collection for every header, title or cell.

Public Member Functions

HRESULT BandingOption ([out, retval] VARIANT_BOOL *pBanding)

Get the banding option of the grid.

HRESULT FormatCount ([out, retval] Int32 *pCount)

This method retrieves the number of format objects used by anything on the grid.

HRESULT FormatItem ([in] Int32 Index,[out, retval] IDSSFormat ppFormat)

This method retrieves the format object by index.

HRESULT GetColumnScenario ([out, retval] EnumDSSWidthScenario *pColScenario)

HRESULT GetDataColumnWidths ([out] Int32 *oDataColumnWidths)

HRESULT GetDataColumnWidthsCount ([out, retval] Int32 *pDataColumnWidthsCount)

HRESULT GetDataFormat ([in] Int32 RowNum,[in] Int32 ColumnNum,[out, optional] VARIANT *pValue,[out, optional] Int32 *pFormatIndex,[out, optional] BSTR *pText,[out, optional] Int32 *pColor)

Get format info for data cell.

HRESULT GetDefaultHeaderWidth ([out, retval] Int32 *pDefaultHeaderWidth)

HRESULT GetExtraWidth ([out, retval] Int32 *pExtraWidth)

HRESULT GetHeaderFormat ([in] IDSSElement *pElement,[in, optional] Int32 FormID,[out, optional] VARIANT *pValue,[out, optional] Int32 *pFormatIndex,[out, optional] BSTR *pText)

Get format info for header element.

HRESULT GetHeaderFormat2 ([in] EnumDSSAxisName Axis,[in] Int32 Ordinal,[in] Int32 Depth,[in, optional] Int32 FormID,[out, optional] VARIANT *pValue,[out, optional] Int32 *pFormatIndex,[out, optional] BSTR *pText)

Get format info for header element according to position.

HRESULT GetRowHeaderWidths ([out] Int32 *pRowHeaderWidths)

HRESULT GetRowHeaderWidthsCount ([out, retval] Int32 *pHeaderWidthsCount)

HRESULT GetRowHeight ([out, retval] Int32 *pRowHeight)

HRESULT GetRowScenario ([out, retval] EnumDSSWidthScenario *pRowScenario)

HRESULT GetTitleFormat ([in] IDSSTemplateUnit *pUnit,[out, optional] Int32 *pFormatIndex,[out, optional] BSTR *pText)

Get format info for title unit.

HRESULT GetTitleFormat2 ([in] EnumDSSAxisName Axis,[in] Int32 UnitIndex,[out, optional] Int32 *pFormatIndex,[out, optional] BSTR *pText)

Get format info for title unit according to position.

HRESULT InitSlicedData ([in] IDSSXTabDataAccess *pSlicedData)

HRESULT ReportInstance ([out, retval] IDSSReportInstance ppReportInstance)

This method retrieves the report instance associated with this grid formatter.

HRESULT Template ([out, retval] IDSSTemplate ppTemplate)

This method retrieves the template associated with this grid formatter.

Member Function Documentation

HRESULT IDSSGridFormatter::BandingOption ( [out, retval] VARIANT_BOOL * pBanding )

Get the banding option of the grid.

Parameters:

pBanding true if the grid has banding style.

HRESULT IDSSGridFormatter::FormatCount ( [out, retval] Int32 * pCount )

This method retrieves the number of format objects used by anything on the grid.

Parameters:

pCount number of Format objects in the collection.

HRESULT IDSSGridFormatter::FormatItem ( [in] Int32 Index,

[out, retval] IDSSFormat ppFormat

)

This method retrieves the format object by index.

Parameters:

Index Index number of this format in the collection of all formats.

ppFormat the Format object

HRESULT IDSSGridFormatter::GetColumnScenario ( [out, retval] EnumDSSWidthScenario * pColScenario )

HRESULT IDSSGridFormatter::GetDataColumnWidths ( [out] Int32 * oDataColumnWidths )

HRESULT IDSSGridFormatter::GetDataColumnWidthsCount ( [out, retval] Int32 * pDataColumnWidthsCount )

HRESULT IDSSGridFormatter::GetDataFormat ( [in] Int32 RowNum,

[in] Int32 ColumnNum,

[out, optional] VARIANT * pValue,

[out, optional] Int32 * pFormatIndex,

[out, optional] BSTR * pText,

[out, optional] Int32 * pColor

)

Get format info for data cell.

Parameters:

RowNum row number of the cell.

ColumnNum row number of the cell.

pValue the unformatted value of the data.

pFormatIndex index into the format objects collection.

pText the formatted string of the data.

pColor the color of the text

HRESULT IDSSGridFormatter::GetDefaultHeaderWidth ( [out, retval] Int32 * pDefaultHeaderWidth )

HRESULT IDSSGridFormatter::GetExtraWidth ( [out, retval] Int32 * pExtraWidth )

HRESULT IDSSGridFormatter::GetHeaderFormat ( [in] IDSSElement * pElement,

[in, optional] Int32 FormID,

[out, optional] VARIANT * pValue,

[out, optional] Int32 * pFormatIndex,

[out, optional] BSTR * pText

)

Get format info for header element.

Parameters:

pElement pointer to the template element.

FormID form ID if the template element is an attribute element.

pValue the unformatted value of the title.

pFormatIndex index into the format objects collection.

pText the formatted string of the title.

HRESULT IDSSGridFormatter::GetHeaderFormat2 ( [in] EnumDSSAxisName Axis,

[in] Int32 Ordinal,

[in] Int32 Depth,

[in, optional] Int32 FormID,

[out, optional] VARIANT * pValue,

[out, optional] Int32 * pFormatIndex,

[out, optional] BSTR * pText

)

Get format info for header element according to position.

Parameters:

Axis Index number identifying the axis containing the header element.

Ordinal Index number (on the grid) of the row containing the desired element.

Depth Depth (within the header cells) of the desired header element.

FormID form ID if the template element is an attribute element.

pValue The unformatted value of the title.

pFormatIndex Index into the format objects collection.

pText The formatted string of the title.

HRESULT IDSSGridFormatter::GetRowHeaderWidths ( [out] Int32 * pRowHeaderWidths )

HRESULT IDSSGridFormatter::GetRowHeaderWidthsCount ( [out, retval] Int32 * pHeaderWidthsCount )

HRESULT IDSSGridFormatter::GetRowHeight ( [out, retval] Int32 * pRowHeight )

HRESULT IDSSGridFormatter::GetRowScenario ( [out, retval] EnumDSSWidthScenario * pRowScenario )

HRESULT IDSSGridFormatter::GetTitleFormat ( [in] IDSSTemplateUnit * pUnit,

[out, optional] Int32 * pFormatIndex,

[out, optional] BSTR * pText

)

Get format info for title unit.

Parameters:

pUnit pointer to the template unit corresponding to the title.

pFormatIndex index into the format objects collection.

pText the formatted string of the title.

HRESULT IDSSGridFormatter::GetTitleFormat2 ( [in] EnumDSSAxisName Axis,

[in] Int32 UnitIndex,

[out, optional] Int32 * pFormatIndex,

[out, optional] BSTR * pText

)

Get format info for title unit according to position.

Parameters:

Axis name of the axis the template unit is on.

UnitIndex index of the unit on the axis.

pFormatIndex index into the format objects collection.

pText the formatted string of the title.

HRESULT IDSSGridFormatter::InitSlicedData ( [in] IDSSXTabDataAccess * pSlicedData )

HRESULT IDSSGridFormatter::ReportInstance ( [out, retval] IDSSReportInstance ppReportInstance )

This method retrieves the report instance associated with this grid formatter.

Parameters:

ppReportInstance the report instance associated with this grid formatter

HRESULT IDSSGridFormatter::Template ( [out, retval] IDSSTemplate ppTemplate )

This method retrieves the template associated with this grid formatter.

Parameters:

ppTemplate the template associated with this grid formatter


Public Member Functions
HRESULT	BandingOption ([out, retval] VARIANT_BOOL *pBanding)
	Get the banding option of the grid.
HRESULT	FormatCount ([out, retval] Int32 *pCount)
	This method retrieves the number of format objects used by anything on the grid.
HRESULT	FormatItem ([in] Int32 Index,[out, retval] IDSSFormat ppFormat)
	This method retrieves the format object by index.
HRESULT	GetColumnScenario ([out, retval] EnumDSSWidthScenario *pColScenario)
HRESULT	GetDataColumnWidths ([out] Int32 *oDataColumnWidths)
HRESULT	GetDataColumnWidthsCount ([out, retval] Int32 *pDataColumnWidthsCount)
HRESULT	GetDataFormat ([in] Int32 RowNum,[in] Int32 ColumnNum,[out, optional] VARIANT pValue,[out, optional] Int32 pFormatIndex,[out, optional] BSTR pText,[out, optional] Int32 pColor)
	Get format info for data cell.
HRESULT	GetDefaultHeaderWidth ([out, retval] Int32 *pDefaultHeaderWidth)
HRESULT	GetExtraWidth ([out, retval] Int32 *pExtraWidth)
HRESULT	GetHeaderFormat ([in] IDSSElement pElement,[in, optional] Int32 FormID,[out, optional] VARIANT pValue,[out, optional] Int32 pFormatIndex,[out, optional] BSTR pText)
	Get format info for header element.
HRESULT	GetHeaderFormat2 ([in] EnumDSSAxisName Axis,[in] Int32 Ordinal,[in] Int32 Depth,[in, optional] Int32 FormID,[out, optional] VARIANT pValue,[out, optional] Int32 pFormatIndex,[out, optional] BSTR *pText)
	Get format info for header element according to position.
HRESULT	GetRowHeaderWidths ([out] Int32 *pRowHeaderWidths)
HRESULT	GetRowHeaderWidthsCount ([out, retval] Int32 *pHeaderWidthsCount)
HRESULT	GetRowHeight ([out, retval] Int32 *pRowHeight)
HRESULT	GetRowScenario ([out, retval] EnumDSSWidthScenario *pRowScenario)
HRESULT	GetTitleFormat ([in] IDSSTemplateUnit pUnit,[out, optional] Int32 pFormatIndex,[out, optional] BSTR *pText)
	Get format info for title unit.
HRESULT	GetTitleFormat2 ([in] EnumDSSAxisName Axis,[in] Int32 UnitIndex,[out, optional] Int32 pFormatIndex,[out, optional] BSTR pText)
	Get format info for title unit according to position.
HRESULT	InitSlicedData ([in] IDSSXTabDataAccess *pSlicedData)
HRESULT	ReportInstance ([out, retval] IDSSReportInstance ppReportInstance)
	This method retrieves the report instance associated with this grid formatter.
HRESULT	Template ([out, retval] IDSSTemplate ppTemplate)
	This method retrieves the template associated with this grid formatter.