Represents Microsoft Excel Chart object. More...

Inheritance diagram for wxAutoExcel::wxExcelChart:

Public Member Functions
void	Activate ()
	Makes the current chart the active chart. More...

void	ApplyChartTemplate (const wxString &fileName)
	Applies a standard or custom chart type to a chart. More...

void	ApplyDataLabels (XlDataLabelsType *type=NULL, wxXlTribool legendKey=wxDefaultXlTribool, wxXlTribool autoText=wxDefaultXlTribool, wxXlTribool hasLeaderLines=wxDefaultXlTribool, wxXlTribool showSeriesName=wxDefaultXlTribool, wxXlTribool showCategoryName=wxDefaultXlTribool, wxXlTribool showValue=wxDefaultXlTribool, wxXlTribool showPercentage=wxDefaultXlTribool, wxXlTribool showBubbleSize=wxDefaultXlTribool, const wxString &separator=wxEmptyString)
	Applies data labels to all the series in a chart. More...

void	ApplyLayout (long layout, XlChartType *chartType=NULL)
	Applies the layouts shown in the ribbon. More...

wxExcelAxes	Axes ()
	Returns an object that represents either a single axis or a collection of the axes on the chart. More...

wxExcelChartGroups	ChartGroups ()
	Returns an object that represents either a single chart group (a ChartGroup object) or a collection of all the chart groups in the chart (a ChartGroups object). More...

wxExcelChartObjects	ChartObjects ()
	Returns an object that represents either a single embedded chart (a ChartObject object) or a collection of all the embedded charts (a ChartObjects object) on the sheet. More...

void	ChartWizard (wxExcelRange source=NULL, XlChartType gallery=NULL, long format=NULL, XlRowCol plotBy=NULL, long categoryLabels=NULL, long seriesLabels=NULL, wxXlTribool hasLegend=wxDefaultXlTribool, const wxString &title=wxEmptyString, const wxString &categoryTitle=wxEmptyString, const wxString &valueTitle=wxEmptyString, const wxString &extraTitle=wxEmptyString)
	Modifies the properties of the given chart. More...

void	CheckSpelling (const wxString &customDictionary=wxEmptyString, wxXlTribool ignoreUpperCase=wxDefaultXlTribool, wxXlTribool alwaysSuggest=wxDefaultXlTribool, MsoLanguageID *spellLang=NULL)
	Checks the spelling of an object. More...

void	ClearToMatchColorStyle ()
	lears all colors on the specified chart that do not follow the color style applied to the chart. More...

void	ClearToMatchStyle ()
	Clears the chart elements formatting to automatic. More...

void	CopyPicture (XlPictureAppearance appearance, XlCopyPictureFormat format)
	Copies the selected object to the Clipboard as a picture. More...

void	Delete ()
	Deletes the object. More...

void	Deselect ()
	Cancels the selection for the specified chart. More...

bool	Export (const wxString &fileName, const wxString &filterName=wxEmptyString, wxXlTribool interactive=wxDefaultXlTribool)
	Exports the chart in a graphic format. More...

wxExcelSeriesCollection	FullSeriesCollection ()
	Returns an object that represents either a single series (a Series object) or a collection of all the series (a SeriesCollection collection) in the chart or chart group. More...

wxExcelChart	Location (XlChartLocation where, const wxString &name=wxEmptyString)
	Moves the chart to a new location. More...

bool	Move ()
	Moves the chart to the new workbook. More...

bool	MoveAfterOrBefore (wxExcelSheet sheetAfterOrBefore, bool after)
	Moves the chart within the same workbook, after or before the specified sheet. More...

wxExcelOLEObjects	OLEObjects ()
	Returns an object that represents either a single OLE object (an OLEObject ) or a collection of all OLE objects (an OLEObjects collection) on the chart or sheet. More...

void	Paste (XlPasteType *type=NULL)
	Pastes chart data from the Clipboard into the specified chart. More...

bool	PrintOut (long from=NULL, long to=NULL, long *copies=NULL, wxXlTribool preview=wxDefaultXlTribool, const wxString &activePrinter=wxEmptyString, wxXlTribool printToFile=wxDefaultXlTribool, wxXlTribool collate=wxDefaultXlTribool, const wxString &prToFileName=wxEmptyString)
	Prints the object. More...

bool	PrintPreview (wxXlTribool enableChanges=wxDefaultXlTribool)
	Shows a preview of the object as it would look when printed. More...

void	Protect (const wxString &password=wxEmptyString, wxXlTribool shapes=wxDefaultXlTribool, wxXlTribool contents=wxDefaultXlTribool, wxXlTribool userInterfaceOnly=wxDefaultXlTribool)
	Protects a chart so that it cannot be modified. More...

void	Refresh ()
	Causes the specified chart to be redrawn immediately. More...

void	SaveAs (const wxString &fileName=wxEmptyString, XlFileFormat *fileFormat=NULL, const wxString &password=wxEmptyString, const wxString &writeResPassword=wxEmptyString, wxXlTribool readOnlyRecommended=wxDefaultXlTribool, wxXlTribool createBackup=wxDefaultXlTribool, wxXlTribool addToMru=wxDefaultXlTribool, wxXlTribool local=wxDefaultXlTribool)
	Saves changes to the chart in a different file. More...

void	SaveChartTemplate (const wxString &fileName)
	Saves a custom chart template to the list of available chart templates. More...

void	Select (wxXlTribool replace=wxDefaultXlTribool)
	Selects the object. More...

wxExcelSeriesCollection	SeriesCollection ()
	Returns an object that represents either a single series (a Series object) or a collection of all the series (a SeriesCollection collection) in the chart or chart group. More...

void	SetBackgroundPicture (const wxString &fileName)
	Sets the background graphic for a chart. More...

void	SetDefaultChart (const wxString &name=wxEmptyString)
	Specifies the name of the chart template that Microsoft Excel uses when creating new charts. More...

void	SetElement (MsoChartElementType element)
	Sets chart elements on a chart. More...

void	SetSourceData (wxExcelRange source, XlRowCol *plotBy=NULL)
	Sets the source data range for the chart. More...

void	Unprotect (const wxString &password=wxEmptyString)
	Removes protection from a sheet or workbook. More...

bool	GetAutoScaling ()
	True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. More...

void	SetAutoScaling (bool autoScaling)
	True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. More...

wxExcelWalls	GetBackWall ()
	Returns a Walls object that allows the user to individually format the back wall of a 3-D chart. More...

XlBarShape	GetBarShape ()
	Returns the shape used with the 3-D bar or column chart. More...

void	SetBarShape (XlBarShape barShape)
	Sets the shape used with the 3-D bar or column chart. More...

long	GetCategoryLabelLevel ()
	Returns a XlCategoryLabelLevel Enumeration (Excel) constant referring to the level of where the category labels are being sourced from. More...

void	SetCategoryLabelLevel (long level)
	Sets a XlCategoryLabelLevel Enumeration (Excel) constant referring to the level of where the category labels are being sourced from. More...

wxExcelChartArea	GetChartArea ()
	Returns a ChartArea object that represents the complete chart area for the chart. More...

long	GetChartColor ()
	Returns an Integer that represents the color scheme for the chart. More...

void	SetChartColor (long color)
	Sets an Integer that represents the color scheme for the chart. More...

long	GetChartStyle ()
	Returns the chart style for the chart. More...

void	SetChartStyle (long chartStyle)
	Sets the chart style for the chart. More...

wxExcelChartTitle	GetChartTitle ()
	Returns a ChartTitle object that represents the title of the specified chart. More...

XlChartType	GetChartType ()
	Returns the chart type. More...

void	SetChartType (XlChartType chartType)
	Sets the chart type. More...

wxString	GetCodeName ()
	Returns the code name for the object. More...

long	GetCreator ()
	Returns a 32-bit integer that indicates the application in which this object was created. More...

wxExcelDataTable	GetDataTable ()
	Returns a DataTable object that represents the chart data table. More...

long	GetDepthPercent ()
	Returns the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent). More...

void	SetDepthPercent (long depthPercent)
	Sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent). More...

XlDisplayBlanksAs	GetDisplayBlanksAs ()
	Returns the way that blank cells are plotted on a chart. More...

void	SetDisplayBlanksAs (XlDisplayBlanksAs displayBlanksAs)
	Sets the way that blank cells are plotted on a chart. More...

long	GetElevation ()
	Returns the elevation of the 3-D chart view, in degrees. More...

void	SetElevation (long elevation)
	Sets the elevation of the 3-D chart view, in degrees. More...

wxExcelFloor	GetFloor ()
	Returns a Floor object that represents the floor of the 3-D chart. More...

long	GetGapDepth ()
	Returns the distance between the data series in a 3-D chart, as a percentage of the marker width. More...

void	SetGapDepth (long gapDepth)
	Sets the distance between the data series in a 3-D chart, as a percentage of the marker width. More...

bool	GetHasAxis (XlAxisType index1, XlAxisGroup *index2=NULL)
	Returns which axes exist on the chart. More...

void	SetHasAxis (bool hasAxis, XlAxisType index1, XlAxisGroup *index2=NULL)
	Sets which axes exist on the chart. More...

bool	GetHasDataTable ()
	True if the chart has a data table. More...

void	SetHasDataTable (bool hasDataTable)
	True if the chart has a data table. More...

bool	GetHasLegend ()
	True if the chart has a legend. More...

void	SetHasLegend (bool hasLegend)
	True if the chart has a legend. More...

bool	GetHasTitle ()
	True if the axis or chart has a visible title. More...

void	SetHasTitle (bool hasTitle)
	True if the axis or chart has a visible title. More...

long	GetHeightPercent ()
	Returns the height of a 3-D chart as a percentage of the chart width (between 1 and 10000 percent). More...

void	SetHeightPercent (long heightPercent)
	Sets the height of a 3-D chart as a percentage of the chart width (between 1 and 10000 percent). More...

wxExcelHyperlinks	GetHyperlinks ()
	Returns a Hyperlinks collection that represents the hyperlinks for the chart. More...

long	GetIndex ()
	Returns a Long value that represents the index number of the object within the collection of similar objects. More...

wxExcelLegend	GetLegend ()
	Returns a Legend object that represents the legend for the chart. More...

wxString	GetName ()
	Returns a String value representing the name of the object. More...

void	SetName (const wxString &name)
	Sets a String value representing the name of the object. More...

wxExcelWorksheet	GetNext ()
	Returns a Worksheet object that represents the next sheet. More...

wxExcelPageSetup	GetPageSetup ()
	Returns a PageSetup object that contains all the page setup settings for the specified object. More...

long	GetPerspective ()
	Returns a Long value that represents the perspective for the 3-D chart view. More...

void	SetPerspective (long perspective)
	Sets a Long value that represents the perspective for the 3-D chart view. More...

wxExcelPlotArea	GetPlotArea ()
	Returns a PlotArea object that represents the plot area of a chart. More...

XlRowCol	GetPlotBy ()
	Returns the way columns or rows are used as data series on the chart. More...

void	SetPlotBy (XlRowCol plotBy)
	Sets the way columns or rows are used as data series on the chart. More...

bool	GetPlotVisibleOnly ()
	True if only visible cells are plotted. More...

void	SetPlotVisibleOnly (bool plotVisibleOnly)
	True if only visible cells are plotted. More...

wxExcelWorksheet	GetPrevious ()
	Returns a Worksheet object that represents the next sheet. More...

bool	GetProtectContents ()
	True if the contents of the sheet are protected. More...

bool	GetProtectData ()
	True if series formulas cannot be modified by the user. More...

void	SetProtectData (bool protectData)
	True if series formulas cannot be modified by the user. More...

bool	GetProtectDrawingObjects ()
	True if shapes are protected. More...

bool	GetProtectFormatting ()
	True if chart formatting cannot be modified by the user. More...

void	SetProtectFormatting (bool protectFormatting)
	True if chart formatting cannot be modified by the user. More...

bool	GetProtectionMode ()
	True if user-interface-only protection is turned on. More...

bool	GetProtectSelection ()
	True if chart elements cannot be selected. More...

void	SetProtectSelection (bool protectSelection)
	True if chart elements cannot be selected. More...

bool	GetRightAngleAxes ()
	True if the chart axes are at right angles, independent of chart rotation or elevation. More...

void	SetRightAngleAxes (bool rightAngleAxes)
	True if the chart axes are at right angles, independent of chart rotation or elevation. More...

long	GetRotation ()
	Returns the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees). More...

void	SetRotation (long rotation)
	Sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees). More...

long	GetSeriesNameLevel ()
	Returns a XlSeriesNameLevel Enumeration (Excel) constant referring to the level of where the series names are being sourced from. More...

void	SetSeriesNameLevel (long level)
	Sets a XlSeriesNameLevel Enumeration (Excel) constant referring to the level of where the series names are being sourced from. More...

wxExcelShapes	GetShapes ()
	Returns a Shapes collection that represents all the shapes on the chart sheet. More...

bool	GetShowDataLabelsOverMaximum ()
	Returns whether to show the data labels when the value is greater than the maximum value on the value axis. More...

void	SetShowDataLabelsOverMaximum (bool showDataLabelsOverMaximum)
	Sets whether to show the data labels when the value is greater than the maximum value on the value axis. More...

wxExcelWalls	GetSideWall ()
	Returns a Walls object that allows the user to individually format the side wall of a 3-D chart. More...

wxExcelTab	GetTab ()
	Returns a Tab object for a chart. More...

XlSheetVisibility	GetVisible ()
	Returns an XlSheetVisibility value that determines whether the object is visible. More...

void	SetVisible (XlSheetVisibility visible)
	Sets an XlSheetVisibility value that determines whether the object is visible. More...

wxExcelWalls	GetWalls ()
	Returns a Walls object that represents the walls of the 3-D chart. More...

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Chart". More...

Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool	IsOk_ () const
	Returns true if the object has a valid dispatch. More...

wxString	GetAutomationObjectName_ (bool stripUnderscores=false) const
	Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL). More...

wxSharedPtr< wxAutomationObject >	GetAutomationObject_ ()
	Returns the underlying wxAutomationObject. More...

	operator bool () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e. More...

WXLCID	GetAutomationLCID_ () const
	Returns the locale identifier used in automation calls. More...

bool	SetAutomationLCID_ (WXLCID lcid)
	Sets the locale identifier to be used in automation calls. More...

bool	GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
	Returns lists of property and method names the automation interface exposes. More...

bool	GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
	Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use. More...

Additional Inherited Members
Public Types inherited from wxAutoExcel::wxExcelObject
enum	ErrorFlags { Err_DoNothing = 0 , Err_LogOnInvalidDispatch = 1 , Err_AssertOnInvalidDispatch = 1 << 1 , Err_ThrowOnInvalidDispatch = 1 << 2 , Err_LogOnInvalidArgument = 1 << 3 , Err_AssertOnInvalidArgument = 1 << 4 , Err_ThrowOnInvalidArgument = 1 << 5 , Err_LogOnFailedInvoke = 1 << 6 , Err_AssertOnFailedInvoke = 1 << 7 , Err_ThrowOnFailedInvoke = 1 << 8 , Err_LogOnInvalidReturnType = 1 << 9 , Err_AssertOnInvalidReturnType = 1 << 10 , Err_ThrowOnInvalidReturnType = 1 << 11 , Err_LogOnOtherError = 1 << 12 , Err_AssertOnOtherError = 1 << 13 , Err_ThrowOnOtherError = 1 << 14 }
	Flags affecting the behaviour of wxExcelObject and its descendants when an error occurs during accessing an Excel object property or calling its method. More...

Static Public Member Functions inherited from wxAutoExcel::wxExcelObject
static unsigned	GetErrorMode_ ()
	Sets the error mode to the combination of wxExcelObject::ErrorFlags. More...

static void	SetErrorMode_ (unsigned mode)
	Sets the error mode as the combination of wxExcelObject::ErrorFlags. More...

static bool	GetUnimplementedCollectionItem_ (wxAutomationObject &collection, const long index, wxAutomationObject &item, bool asProperty)
	Helper function for obtaining an item from MS Excel collection not implemented in wxAutoExcel, see FAQ on how to use. More...

Detailed Description

Represents Microsoft Excel Chart object.

Member Function Documentation

◆ Activate()

void wxAutoExcel::wxExcelChart::Activate ( )

Makes the current chart the active chart.

MSDN documentation for Chart.Activate.

◆ ApplyChartTemplate()

void wxAutoExcel::wxExcelChart::ApplyChartTemplate ( const wxString & fileName )

Applies a standard or custom chart type to a chart.

MSDN documentation for Chart.ApplyChartTemplate.

◆ ApplyDataLabels()

void wxAutoExcel::wxExcelChart::ApplyDataLabels	(	XlDataLabelsType *	type = `NULL`,
		wxXlTribool	legendKey = `wxDefaultXlTribool`,
		wxXlTribool	autoText = `wxDefaultXlTribool`,
		wxXlTribool	hasLeaderLines = `wxDefaultXlTribool`,
		wxXlTribool	showSeriesName = `wxDefaultXlTribool`,
		wxXlTribool	showCategoryName = `wxDefaultXlTribool`,
		wxXlTribool	showValue = `wxDefaultXlTribool`,
		wxXlTribool	showPercentage = `wxDefaultXlTribool`,
		wxXlTribool	showBubbleSize = `wxDefaultXlTribool`,
		const wxString &	separator = `wxEmptyString`
	)

Applies data labels to all the series in a chart.

MSDN documentation for Chart.ApplyDataLabels.

◆ ApplyLayout()

void wxAutoExcel::wxExcelChart::ApplyLayout	(	long	layout,
		XlChartType *	chartType = `NULL`
	)

Applies the layouts shown in the ribbon.

MSDN documentation for Chart.ApplyLayout.

◆ Axes()

wxExcelAxes wxAutoExcel::wxExcelChart::Axes ( )

Returns an object that represents either a single axis or a collection of the axes on the chart.

MSDN documentation for Chart.Axes.

◆ ChartGroups()

wxExcelChartGroups wxAutoExcel::wxExcelChart::ChartGroups ( )

Returns an object that represents either a single chart group (a ChartGroup object) or a collection of all the chart groups in the chart (a ChartGroups object).

The returned collection includes every type of group.

MSDN documentation for Chart.ChartGroups.

◆ ChartObjects()

wxExcelChartObjects wxAutoExcel::wxExcelChart::ChartObjects ( )

Returns an object that represents either a single embedded chart (a ChartObject object) or a collection of all the embedded charts (a ChartObjects object) on the sheet.

MSDN documentation for Chart.ChartObjects.

◆ ChartWizard()

void wxAutoExcel::wxExcelChart::ChartWizard	(	wxExcelRange *	source = `NULL`,
		XlChartType *	gallery = `NULL`,
		long *	format = `NULL`,
		XlRowCol *	plotBy = `NULL`,
		long *	categoryLabels = `NULL`,
		long *	seriesLabels = `NULL`,
		wxXlTribool	hasLegend = `wxDefaultXlTribool`,
		const wxString &	title = `wxEmptyString`,
		const wxString &	categoryTitle = `wxEmptyString`,
		const wxString &	valueTitle = `wxEmptyString`,
		const wxString &	extraTitle = `wxEmptyString`
	)

Modifies the properties of the given chart.

You can use this method to quickly format a chart without setting all the individual properties. This method is noninteractive, and it changes only the specified properties.

MSDN documentation for Chart.ChartWizard.

◆ CheckSpelling()

void wxAutoExcel::wxExcelChart::CheckSpelling	(	const wxString &	customDictionary = `wxEmptyString`,
		wxXlTribool	ignoreUpperCase = `wxDefaultXlTribool`,
		wxXlTribool	alwaysSuggest = `wxDefaultXlTribool`,
		MsoLanguageID *	spellLang = `NULL`
	)

Checks the spelling of an object.

MSDN documentation for Chart.CheckSpelling.

◆ ClearToMatchColorStyle()

void wxAutoExcel::wxExcelChart::ClearToMatchColorStyle ( )

lears all colors on the specified chart that do not follow the color style applied to the chart.

[MSDN documentation for Chart.ClearToMatchColorStyle](https://msdn.microsoft.com/vba/excel-vba/articles/chart-cleartomatchcolorstyle-method-excel.

◆ ClearToMatchStyle()

void wxAutoExcel::wxExcelChart::ClearToMatchStyle ( )

Clears the chart elements formatting to automatic.

MSDN documentation for Chart.ClearToMatchStyle.

◆ CopyPicture()

void wxAutoExcel::wxExcelChart::CopyPicture	(	XlPictureAppearance *	appearance,
		XlCopyPictureFormat *	format
	)

Copies the selected object to the Clipboard as a picture.

MSDN documentation for Chart.CopyPicture.

◆ Delete()

void wxAutoExcel::wxExcelChart::Delete ( )

Deletes the object.

MSDN documentation for Chart.Delete.

◆ Deselect()

void wxAutoExcel::wxExcelChart::Deselect ( )

Cancels the selection for the specified chart.

MSDN documentation for Chart.Delete.

◆ Export()

bool wxAutoExcel::wxExcelChart::Export	(	const wxString &	fileName,
		const wxString &	filterName = `wxEmptyString`,
		wxXlTribool	interactive = `wxDefaultXlTribool`
	)

Exports the chart in a graphic format.

MSDN documentation for Chart.Export.

◆ FullSeriesCollection()

wxExcelSeriesCollection wxAutoExcel::wxExcelChart::FullSeriesCollection ( )

Returns an object that represents either a single series (a Series object) or a collection of all the series (a SeriesCollection collection) in the chart or chart group.

MSDN documentation for Chart.FullSeriesCollection.

◆ Location()

wxExcelChart wxAutoExcel::wxExcelChart::Location	(	XlChartLocation	where,
		const wxString &	name = `wxEmptyString`
	)

Moves the chart to a new location.

MSDN documentation for Chart.Location.

◆ Move()

bool wxAutoExcel::wxExcelChart::Move ( )

Moves the chart to the new workbook.

MSDN documentation for Chart.Move.

◆ MoveAfterOrBefore()

bool wxAutoExcel::wxExcelChart::MoveAfterOrBefore	(	wxExcelSheet	sheetAfterOrBefore,
		bool	after
	)

Moves the chart within the same workbook, after or before the specified sheet.

MSDN documentation for Chart.Move.

◆ OLEObjects()

wxExcelOLEObjects wxAutoExcel::wxExcelChart::OLEObjects ( )

Returns an object that represents either a single OLE object (an OLEObject ) or a collection of all OLE objects (an OLEObjects collection) on the chart or sheet.

Read-only.

MSDN documentation for Chart.OLEObjects.

◆ Paste()

void wxAutoExcel::wxExcelChart::Paste ( XlPasteType * type = NULL )

Pastes chart data from the Clipboard into the specified chart.

MSDN documentation for Chart.Paste.

◆ PrintOut()

bool wxAutoExcel::wxExcelChart::PrintOut	(	long *	from = `NULL`,
		long *	to = `NULL`,
		long *	copies = `NULL`,
		wxXlTribool	preview = `wxDefaultXlTribool`,
		const wxString &	activePrinter = `wxEmptyString`,
		wxXlTribool	printToFile = `wxDefaultXlTribool`,
		wxXlTribool	collate = `wxDefaultXlTribool`,
		const wxString &	prToFileName = `wxEmptyString`
	)

Prints the object.

MSDN documentation for Chart.PrintOut.

◆ PrintPreview()

bool wxAutoExcel::wxExcelChart::PrintPreview ( wxXlTribool enableChanges = wxDefaultXlTribool )

Shows a preview of the object as it would look when printed.

MSDN documentation for Chart.PrintPreview.

◆ Protect()

void wxAutoExcel::wxExcelChart::Protect	(	const wxString &	password = `wxEmptyString`,
		wxXlTribool	shapes = `wxDefaultXlTribool`,
		wxXlTribool	contents = `wxDefaultXlTribool`,
		wxXlTribool	userInterfaceOnly = `wxDefaultXlTribool`
	)

Protects a chart so that it cannot be modified.

MSDN documentation for Chart.Protect.

◆ Refresh()

void wxAutoExcel::wxExcelChart::Refresh ( )

Causes the specified chart to be redrawn immediately.

MSDN documentation for Chart.Refresh.

◆ SaveAs()

void wxAutoExcel::wxExcelChart::SaveAs	(	const wxString &	fileName = `wxEmptyString`,
		XlFileFormat *	fileFormat = `NULL`,
		const wxString &	password = `wxEmptyString`,
		const wxString &	writeResPassword = `wxEmptyString`,
		wxXlTribool	readOnlyRecommended = `wxDefaultXlTribool`,
		wxXlTribool	createBackup = `wxDefaultXlTribool`,
		wxXlTribool	addToMru = `wxDefaultXlTribool`,
		wxXlTribool	local = `wxDefaultXlTribool`
	)

Saves changes to the chart in a different file.

MSDN documentation for Chart.SaveAs.

◆ SaveChartTemplate()

void wxAutoExcel::wxExcelChart::SaveChartTemplate ( const wxString & fileName )

Saves a custom chart template to the list of available chart templates.

MSDN documentation for Chart.SaveChartTemplate.

◆ Select()

void wxAutoExcel::wxExcelChart::Select ( wxXlTribool replace = wxDefaultXlTribool )

Selects the object.

MSDN documentation for Chart.Select.

◆ SeriesCollection()

wxExcelSeriesCollection wxAutoExcel::wxExcelChart::SeriesCollection ( )

Returns an object that represents either a single series (a Series object) or a collection of all the series (a SeriesCollection collection) in the chart or chart group.

MSDN documentation for Chart.SeriesCollection.

◆ SetBackgroundPicture()

void wxAutoExcel::wxExcelChart::SetBackgroundPicture ( const wxString & fileName )

Sets the background graphic for a chart.

MSDN documentation for Chart.SetBackgroundPicture.

◆ SetDefaultChart()

void wxAutoExcel::wxExcelChart::SetDefaultChart ( const wxString & name = wxEmptyString )

Specifies the name of the chart template that Microsoft Excel uses when creating new charts.

If name is an empty string, xlBuiltIn will be used.

MSDN documentation for Chart.SetDefaultChart.

◆ SetElement()

void wxAutoExcel::wxExcelChart::SetElement ( MsoChartElementType element )

Sets chart elements on a chart.

Read/write MsoChartElementType.

MSDN documentation for Chart.SetElement.

◆ SetSourceData()

void wxAutoExcel::wxExcelChart::SetSourceData	(	wxExcelRange	source,
		XlRowCol *	plotBy = `NULL`
	)

Sets the source data range for the chart.

MSDN documentation for Chart.SetSourceData.

◆ Unprotect()

void wxAutoExcel::wxExcelChart::Unprotect ( const wxString & password = wxEmptyString )

Removes protection from a sheet or workbook.

This method has no effect if the sheet or workbook isn't protected.

MSDN documentation for Chart.Unprotect.

◆ GetAutoScaling()

bool wxAutoExcel::wxExcelChart::GetAutoScaling ( )

True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.

The RightAngleAxes property must be True.

MSDN documentation for Chart.AutoScaling.

◆ SetAutoScaling()

void wxAutoExcel::wxExcelChart::SetAutoScaling ( bool autoScaling )

True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.

The RightAngleAxes property must be True.

MSDN documentation for Chart.AutoScaling.

◆ GetBackWall()

wxExcelWalls wxAutoExcel::wxExcelChart::GetBackWall ( )

Returns a Walls object that allows the user to individually format the back wall of a 3-D chart.

Since Excel 2007.

MSDN documentation for Chart.BackWall.

◆ GetBarShape()

XlBarShape wxAutoExcel::wxExcelChart::GetBarShape ( )

Returns the shape used with the 3-D bar or column chart.

Read/write XlBarShape.

MSDN documentation for Chart.BarShape.

◆ SetBarShape()

void wxAutoExcel::wxExcelChart::SetBarShape ( XlBarShape barShape )

Sets the shape used with the 3-D bar or column chart.

Read/write XlBarShape.

MSDN documentation for Chart.BarShape.

◆ GetCategoryLabelLevel()

long wxAutoExcel::wxExcelChart::GetCategoryLabelLevel ( )

Returns a XlCategoryLabelLevel Enumeration (Excel) constant referring to the level of where the category labels are being sourced from.

MSDN documentation for Chart.CategoryLabelLevel.

◆ SetCategoryLabelLevel()

void wxAutoExcel::wxExcelChart::SetCategoryLabelLevel ( long level )

Sets a XlCategoryLabelLevel Enumeration (Excel) constant referring to the level of where the category labels are being sourced from.

MSDN documentation for Chart.CategoryLabelLevel.

◆ GetChartArea()

wxExcelChartArea wxAutoExcel::wxExcelChart::GetChartArea ( )

Returns a ChartArea object that represents the complete chart area for the chart.

MSDN documentation for Chart.ChartArea.

◆ GetChartColor()

long wxAutoExcel::wxExcelChart::GetChartColor ( )

Returns an Integer that represents the color scheme for the chart.

MSDN documentation for Chart.ChartColor.

◆ SetChartColor()

void wxAutoExcel::wxExcelChart::SetChartColor ( long color )

Sets an Integer that represents the color scheme for the chart.

MSDN documentation for Chart.ChartColor.

◆ GetChartStyle()

long wxAutoExcel::wxExcelChart::GetChartStyle ( )

Returns the chart style for the chart.

Read/write Variant. Since Excel 2007.

MSDN documentation for Chart.ChartStyle.

◆ SetChartStyle()

void wxAutoExcel::wxExcelChart::SetChartStyle ( long chartStyle )

Sets the chart style for the chart.

Read/write Variant. Since Excel 2007.

MSDN documentation for Chart.ChartStyle.

◆ GetChartTitle()

wxExcelChartTitle wxAutoExcel::wxExcelChart::GetChartTitle ( )

Returns a ChartTitle object that represents the title of the specified chart.

MSDN documentation for Chart.ChartTitle.

◆ GetChartType()

XlChartType wxAutoExcel::wxExcelChart::GetChartType ( )

Returns the chart type.

Read/write XlChartType.

MSDN documentation for Chart.ChartType.

◆ SetChartType()

void wxAutoExcel::wxExcelChart::SetChartType ( XlChartType chartType )

Sets the chart type.

Read/write XlChartType.

MSDN documentation for Chart.ChartType.

◆ GetCodeName()

wxString wxAutoExcel::wxExcelChart::GetCodeName ( )

Returns the code name for the object.

MSDN documentation for Chart.CodeName.

◆ GetCreator()

long wxAutoExcel::wxExcelChart::GetCreator ( )

Returns a 32-bit integer that indicates the application in which this object was created.

MSDN documentation for Chart.Creator.

◆ GetDataTable()

wxExcelDataTable wxAutoExcel::wxExcelChart::GetDataTable ( )

Returns a DataTable object that represents the chart data table.

MSDN documentation for Chart.DataTable.

◆ GetDepthPercent()

long wxAutoExcel::wxExcelChart::GetDepthPercent ( )

Returns the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).

MSDN documentation for Chart.DepthPercent.

◆ SetDepthPercent()

void wxAutoExcel::wxExcelChart::SetDepthPercent ( long depthPercent )

Sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).

MSDN documentation for Chart.DepthPercent.

◆ GetDisplayBlanksAs()

XlDisplayBlanksAs wxAutoExcel::wxExcelChart::GetDisplayBlanksAs ( )

Returns the way that blank cells are plotted on a chart.

Can be one of the XlDisplayBlanksAs constants.

MSDN documentation for Chart.DisplayBlanksAs.

◆ SetDisplayBlanksAs()

void wxAutoExcel::wxExcelChart::SetDisplayBlanksAs ( XlDisplayBlanksAs displayBlanksAs )

Sets the way that blank cells are plotted on a chart.

Can be one of the XlDisplayBlanksAs constants.

MSDN documentation for Chart.DisplayBlanksAs.

◆ GetElevation()

long wxAutoExcel::wxExcelChart::GetElevation ( )

Returns the elevation of the 3-D chart view, in degrees.

MSDN documentation for Chart.Elevation.

◆ SetElevation()

void wxAutoExcel::wxExcelChart::SetElevation ( long elevation )

Sets the elevation of the 3-D chart view, in degrees.

MSDN documentation for Chart.Elevation.

◆ GetFloor()

wxExcelFloor wxAutoExcel::wxExcelChart::GetFloor ( )

Returns a Floor object that represents the floor of the 3-D chart.

MSDN documentation for Chart.Floor.

◆ GetGapDepth()

long wxAutoExcel::wxExcelChart::GetGapDepth ( )

Returns the distance between the data series in a 3-D chart, as a percentage of the marker width.

The value of this property must be between 0 and 500.

MSDN documentation for Chart.GapDepth.

◆ SetGapDepth()

void wxAutoExcel::wxExcelChart::SetGapDepth ( long gapDepth )

Sets the distance between the data series in a 3-D chart, as a percentage of the marker width.

The value of this property must be between 0 and 500.

MSDN documentation for Chart.GapDepth.

◆ GetHasAxis()

bool wxAutoExcel::wxExcelChart::GetHasAxis	(	XlAxisType	index1,
		XlAxisGroup *	index2 = `NULL`
	)

Returns which axes exist on the chart.

Read/write Variant.

MSDN documentation for Chart.HasAxis.

◆ SetHasAxis()

void wxAutoExcel::wxExcelChart::SetHasAxis	(	bool	hasAxis,
		XlAxisType	index1,
		XlAxisGroup *	index2 = `NULL`
	)

Sets which axes exist on the chart.

Read/write Variant.

MSDN documentation for Chart.HasAxis.

◆ GetHasDataTable()

bool wxAutoExcel::wxExcelChart::GetHasDataTable ( )

True if the chart has a data table.

MSDN documentation for Chart.HasDataTable.

◆ SetHasDataTable()

void wxAutoExcel::wxExcelChart::SetHasDataTable ( bool hasDataTable )

True if the chart has a data table.

MSDN documentation for Chart.HasDataTable.

◆ GetHasLegend()

bool wxAutoExcel::wxExcelChart::GetHasLegend ( )

True if the chart has a legend.

MSDN documentation for Chart.HasLegend.

◆ SetHasLegend()

void wxAutoExcel::wxExcelChart::SetHasLegend ( bool hasLegend )

True if the chart has a legend.

MSDN documentation for Chart.HasLegend.

◆ GetHasTitle()

bool wxAutoExcel::wxExcelChart::GetHasTitle ( )

True if the axis or chart has a visible title.

MSDN documentation for Chart.HasTitle.

◆ SetHasTitle()

void wxAutoExcel::wxExcelChart::SetHasTitle ( bool hasTitle )

True if the axis or chart has a visible title.

MSDN documentation for Chart.HasTitle.

◆ GetHeightPercent()

long wxAutoExcel::wxExcelChart::GetHeightPercent ( )

Returns the height of a 3-D chart as a percentage of the chart width (between 1 and 10000 percent).

MSDN documentation for Chart.HeightPercent.

◆ SetHeightPercent()

void wxAutoExcel::wxExcelChart::SetHeightPercent ( long heightPercent )

Sets the height of a 3-D chart as a percentage of the chart width (between 1 and 10000 percent).

MSDN documentation for Chart.HeightPercent.

◆ GetHyperlinks()

wxExcelHyperlinks wxAutoExcel::wxExcelChart::GetHyperlinks ( )

Returns a Hyperlinks collection that represents the hyperlinks for the chart.

MSDN documentation for Chart.Hyperlinks.

◆ GetIndex()

long wxAutoExcel::wxExcelChart::GetIndex ( )

Returns a Long value that represents the index number of the object within the collection of similar objects.

MSDN documentation for Chart.Index.

◆ GetLegend()

wxExcelLegend wxAutoExcel::wxExcelChart::GetLegend ( )

Returns a Legend object that represents the legend for the chart.

MSDN documentation for Chart.Legend.

◆ GetName()

wxString wxAutoExcel::wxExcelChart::GetName ( )

Returns a String value representing the name of the object.

MSDN documentation for Chart.Name.

◆ SetName()

void wxAutoExcel::wxExcelChart::SetName ( const wxString & name )

Sets a String value representing the name of the object.

MSDN documentation for Chart.Name.

◆ GetNext()

wxExcelWorksheet wxAutoExcel::wxExcelChart::GetNext ( )

Returns a Worksheet object that represents the next sheet.

MSDN documentation for Chart.Next.

◆ GetPageSetup()

wxExcelPageSetup wxAutoExcel::wxExcelChart::GetPageSetup ( )

Returns a PageSetup object that contains all the page setup settings for the specified object.

MSDN documentation for Chart.PageSetup.

◆ GetPerspective()

long wxAutoExcel::wxExcelChart::GetPerspective ( )

Returns a Long value that represents the perspective for the 3-D chart view.

MSDN documentation for Chart.Perspective.

◆ SetPerspective()

void wxAutoExcel::wxExcelChart::SetPerspective ( long perspective )

Sets a Long value that represents the perspective for the 3-D chart view.

MSDN documentation for Chart.Perspective.

◆ GetPlotArea()

wxExcelPlotArea wxAutoExcel::wxExcelChart::GetPlotArea ( )

Returns a PlotArea object that represents the plot area of a chart.

MSDN documentation for Chart.PlotArea.

◆ GetPlotBy()

XlRowCol wxAutoExcel::wxExcelChart::GetPlotBy ( )

Returns the way columns or rows are used as data series on the chart.

Can be one of the following XlRowCol constants: xlColumns or xlRows.

MSDN documentation for Chart.PlotBy.

◆ SetPlotBy()

void wxAutoExcel::wxExcelChart::SetPlotBy ( XlRowCol plotBy )

Sets the way columns or rows are used as data series on the chart.

Can be one of the following XlRowCol constants: xlColumns or xlRows.

MSDN documentation for Chart.PlotBy.

◆ GetPlotVisibleOnly()

bool wxAutoExcel::wxExcelChart::GetPlotVisibleOnly ( )

True if only visible cells are plotted.

False if both visible and hidden cells are plotted.

MSDN documentation for Chart.PlotVisibleOnly.

◆ SetPlotVisibleOnly()

void wxAutoExcel::wxExcelChart::SetPlotVisibleOnly ( bool plotVisibleOnly )

True if only visible cells are plotted.

False if both visible and hidden cells are plotted.

MSDN documentation for Chart.PlotVisibleOnly.

◆ GetPrevious()

wxExcelWorksheet wxAutoExcel::wxExcelChart::GetPrevious ( )

Returns a Worksheet object that represents the next sheet.

MSDN documentation for Chart.Previous.

◆ GetProtectContents()

bool wxAutoExcel::wxExcelChart::GetProtectContents ( )

True if the contents of the sheet are protected.

For a chart, this protects the entire chart. To turn on content protection, use the Protect method with the Contents argument set to True.

MSDN documentation for Chart.ProtectContents.

◆ GetProtectData()

bool wxAutoExcel::wxExcelChart::GetProtectData ( )

True if series formulas cannot be modified by the user.

MSDN documentation for Chart.ProtectData.

◆ SetProtectData()

void wxAutoExcel::wxExcelChart::SetProtectData ( bool protectData )

True if series formulas cannot be modified by the user.

MSDN documentation for Chart.ProtectData.

◆ GetProtectDrawingObjects()

bool wxAutoExcel::wxExcelChart::GetProtectDrawingObjects ( )

True if shapes are protected.

To turn on shape protection, use the Protect method with the DrawingObjects argument set to True.

MSDN documentation for Chart.ProtectDrawingObjects.

◆ GetProtectFormatting()

bool wxAutoExcel::wxExcelChart::GetProtectFormatting ( )

True if chart formatting cannot be modified by the user.

MSDN documentation for Chart.ProtectFormatting.

◆ SetProtectFormatting()

void wxAutoExcel::wxExcelChart::SetProtectFormatting ( bool protectFormatting )

True if chart formatting cannot be modified by the user.

MSDN documentation for Chart.ProtectFormatting.

◆ GetProtectionMode()

bool wxAutoExcel::wxExcelChart::GetProtectionMode ( )

True if user-interface-only protection is turned on.

To turn on user interface protection, use the Protect method with the UserInterfaceOnly argument set to True.

MSDN documentation for Chart.ProtectionMode.

◆ GetProtectSelection()

bool wxAutoExcel::wxExcelChart::GetProtectSelection ( )

True if chart elements cannot be selected.

MSDN documentation for Chart.ProtectSelection.

◆ SetProtectSelection()

void wxAutoExcel::wxExcelChart::SetProtectSelection ( bool protectSelection )

True if chart elements cannot be selected.

MSDN documentation for Chart.ProtectSelection.

◆ GetRightAngleAxes()

bool wxAutoExcel::wxExcelChart::GetRightAngleAxes ( )

True if the chart axes are at right angles, independent of chart rotation or elevation.

Applies only to 3-D line, column, and bar charts.

MSDN documentation for Chart.RightAngleAxes.

◆ SetRightAngleAxes()

void wxAutoExcel::wxExcelChart::SetRightAngleAxes ( bool rightAngleAxes )

True if the chart axes are at right angles, independent of chart rotation or elevation.

Applies only to 3-D line, column, and bar charts.

MSDN documentation for Chart.RightAngleAxes.

◆ GetRotation()

long wxAutoExcel::wxExcelChart::GetRotation ( )

Returns the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).

The value of this property must be from 0 to 360, except for 3-D bar charts, where the value must be from 0 to 44. The default value is 20. Applies only to 3-D charts. Read/write Variant.

MSDN documentation for Chart.Rotation.

◆ SetRotation()

void wxAutoExcel::wxExcelChart::SetRotation ( long rotation )

Sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).

The value of this property must be from 0 to 360, except for 3-D bar charts, where the value must be from 0 to 44. The default value is 20. Applies only to 3-D charts. Read/write Variant.

MSDN documentation for Chart.Rotation.

◆ GetSeriesNameLevel()

long wxAutoExcel::wxExcelChart::GetSeriesNameLevel ( )

Returns a XlSeriesNameLevel Enumeration (Excel) constant referring to the level of where the series names are being sourced from.

MSDN documentation for Chart.SeriesNameLevel.

◆ SetSeriesNameLevel()

void wxAutoExcel::wxExcelChart::SetSeriesNameLevel ( long level )

Sets a XlSeriesNameLevel Enumeration (Excel) constant referring to the level of where the series names are being sourced from.

MSDN documentation for Chart.SeriesNameLevel.

◆ GetShapes()

wxExcelShapes wxAutoExcel::wxExcelChart::GetShapes ( )

Returns a Shapes collection that represents all the shapes on the chart sheet.

MSDN documentation for Chart.Shapes.

◆ GetShowDataLabelsOverMaximum()

bool wxAutoExcel::wxExcelChart::GetShowDataLabelsOverMaximum ( )

Returns whether to show the data labels when the value is greater than the maximum value on the value axis.

Since Excel 2007.

MSDN documentation for Chart.ShowDataLabelsOverMaximum.

◆ SetShowDataLabelsOverMaximum()

void wxAutoExcel::wxExcelChart::SetShowDataLabelsOverMaximum ( bool showDataLabelsOverMaximum )

Sets whether to show the data labels when the value is greater than the maximum value on the value axis.

Since Excel 2007.

MSDN documentation for Chart.ShowDataLabelsOverMaximum.

◆ GetSideWall()

wxExcelWalls wxAutoExcel::wxExcelChart::GetSideWall ( )

Returns a Walls object that allows the user to individually format the side wall of a 3-D chart.

Since Excel 2007.

MSDN documentation for Chart.SideWall.

◆ GetTab()

wxExcelTab wxAutoExcel::wxExcelChart::GetTab ( )

Returns a Tab object for a chart.

MSDN documentation for Chart.Tab.

◆ GetVisible()

XlSheetVisibility wxAutoExcel::wxExcelChart::GetVisible ( )

Returns an XlSheetVisibility value that determines whether the object is visible.

MSDN documentation for Chart.Visible.

◆ SetVisible()

void wxAutoExcel::wxExcelChart::SetVisible ( XlSheetVisibility visible )

Sets an XlSheetVisibility value that determines whether the object is visible.

MSDN documentation for Chart.Visible.

◆ GetWalls()

wxExcelWalls wxAutoExcel::wxExcelChart::GetWalls ( )

Returns a Walls object that represents the walls of the 3-D chart.

MSDN documentation for Chart.Walls.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelChart::GetAutoExcelObjectName_ ( ) const

inlinevirtual

Returns "Chart".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Activate()

◆ ApplyChartTemplate()

◆ ApplyDataLabels()

◆ ApplyLayout()

◆ Axes()

◆ ChartGroups()

◆ ChartObjects()

◆ ChartWizard()

◆ CheckSpelling()

◆ ClearToMatchColorStyle()

◆ ClearToMatchStyle()

◆ CopyPicture()

◆ Delete()

◆ Deselect()

◆ Export()

◆ FullSeriesCollection()

◆ Location()

◆ Move()

◆ MoveAfterOrBefore()

◆ OLEObjects()

◆ Paste()

◆ PrintOut()

◆ PrintPreview()

◆ Protect()

◆ Refresh()

◆ SaveAs()

◆ SaveChartTemplate()

◆ Select()

◆ SeriesCollection()

◆ SetBackgroundPicture()

◆ SetDefaultChart()

◆ SetElement()

◆ SetSourceData()

◆ Unprotect()

◆ GetAutoScaling()

◆ SetAutoScaling()

◆ GetBackWall()

◆ GetBarShape()

◆ SetBarShape()

◆ GetCategoryLabelLevel()

◆ SetCategoryLabelLevel()

◆ GetChartArea()

◆ GetChartColor()

◆ SetChartColor()

◆ GetChartStyle()

◆ SetChartStyle()

◆ GetChartTitle()

◆ GetChartType()

◆ SetChartType()

◆ GetCodeName()

◆ GetCreator()

◆ GetDataTable()

◆ GetDepthPercent()

◆ SetDepthPercent()

◆ GetDisplayBlanksAs()

◆ SetDisplayBlanksAs()

◆ GetElevation()

◆ SetElevation()

◆ GetFloor()

◆ GetGapDepth()

◆ SetGapDepth()

◆ GetHasAxis()

◆ SetHasAxis()

◆ GetHasDataTable()

◆ SetHasDataTable()

◆ GetHasLegend()

◆ SetHasLegend()

◆ GetHasTitle()

◆ SetHasTitle()

◆ GetHeightPercent()

◆ SetHeightPercent()

◆ GetHyperlinks()

◆ GetIndex()

◆ GetLegend()

◆ GetName()

◆ SetName()